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

data/lib/moonbase/models/single_line_text_field.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class SingleLineTextField < 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::SingleLineTextField::Cardinality]
+      required :cardinality, enum: -> { Moonbase::SingleLineTextField::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., "Company Name").
+      #
+      #   @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., `company_name`).
+      #
+      #   @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/text/single_line` for this field.
+      #
+      #   @return [Symbol, :"field/text/single_line"]
+      required :type, const: :"field/text/single_line"
+
+      # @!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/text/single_line")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::SingleLineTextField} for more details.
+      #
+      #   A field that stores a single line of text without line breaks.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param cardinality [Symbol, Moonbase::Models::SingleLineTextField::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., "Company Name").
+      #
+      #   @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/text/single_line"] The data type of the field. Always `field/text/single_line` for this field.
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      #
+      # @see Moonbase::Models::SingleLineTextField#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/single_line_text_value.rb

@@ -3,20 +3,26 @@
 module Moonbase
   module Models
     class SingleLineTextValue < Moonbase::Internal::Type::BaseModel
-      # @!attribute text
+      # @!attribute data
+      #   A single line of text, up to 1024 characters long. It should not contain line
+      #   breaks.
       #
       #   @return [String]
-      required :text, String
+      required :data, String
 
       # @!attribute type
       #
       #   @return [Symbol, :"value/text/single_line"]
       required :type, const: :"value/text/single_line"
 
-      # @!method initialize(text:, type: :"value/text/single_line")
+      # @!method initialize(data:, type: :"value/text/single_line")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::SingleLineTextValue} for more details.
+      #
       #   A single line of text
       #
-      #   @param text [String]
+      #   @param data [String] A single line of text, up to 1024 characters long. It should not contain line br
+      #
       #   @param type [Symbol, :"value/text/single_line"]
     end
   end

data/lib/moonbase/models/social_linked_in_field.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class SocialLinkedInField < 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::SocialLinkedInField::Cardinality]
+      required :cardinality, enum: -> { Moonbase::SocialLinkedInField::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., "LinkedIn Profile").
+      #
+      #   @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., `linkedin_profile`).
+      #
+      #   @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/uri/social_linked_in` for this field.
+      #
+      #   @return [Symbol, :"field/uri/social_linked_in"]
+      required :type, const: :"field/uri/social_linked_in"
+
+      # @!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/uri/social_linked_in")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::SocialLinkedInField} for more details.
+      #
+      #   A field that stores LinkedIn profile information.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param cardinality [Symbol, Moonbase::Models::SocialLinkedInField::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., "LinkedIn Profile").
+      #
+      #   @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/uri/social_linked_in"] The data type of the field. Always `field/uri/social_linked_in` for this field.
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      #
+      # @see Moonbase::Models::SocialLinkedInField#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/social_linked_in_value.rb

@@ -3,37 +3,48 @@
 module Moonbase
   module Models
     class SocialLinkedInValue < Moonbase::Internal::Type::BaseModel
-      # @!attribute profile
+      # @!attribute data
+      #   The social media profile for the LinkedIn platform
       #
-      #   @return [Moonbase::Models::SocialLinkedInValue::Profile]
-      required :profile, -> { Moonbase::SocialLinkedInValue::Profile }
+      #   @return [Moonbase::Models::SocialLinkedInValue::Data]
+      required :data, -> { Moonbase::SocialLinkedInValue::Data }
 
       # @!attribute type
       #
       #   @return [Symbol, :"value/uri/social_linked_in"]
       required :type, const: :"value/uri/social_linked_in"
 
-      # @!method initialize(profile:, type: :"value/uri/social_linked_in")
-      #   LinkedIn profile link
+      # @!method initialize(data:, type: :"value/uri/social_linked_in")
+      #   The social media profile for the LinkedIn platform
+      #
+      #   @param data [Moonbase::Models::SocialLinkedInValue::Data] The social media profile for the LinkedIn platform
       #
-      #   @param profile [Moonbase::Models::SocialLinkedInValue::Profile]
       #   @param type [Symbol, :"value/uri/social_linked_in"]
 
-      # @see Moonbase::Models::SocialLinkedInValue#profile
-      class Profile < Moonbase::Internal::Type::BaseModel
+      # @see Moonbase::Models::SocialLinkedInValue#data
+      class Data < Moonbase::Internal::Type::BaseModel
         # @!attribute url
+        #   The full URL to the LinkedIn profile.
         #
-        #   @return [String, nil]
-        optional :url, String
+        #   @return [String]
+        required :url, String
 
         # @!attribute username
+        #   The LinkedIn username, including the prefix 'company/' for company pages or
+        #   'in/' for personal profiles.
         #
-        #   @return [String, nil]
-        optional :username, String
+        #   @return [String]
+        required :username, String
 
-        # @!method initialize(url: nil, username: nil)
-        #   @param url [String]
-        #   @param username [String]
+        # @!method initialize(url:, username:)
+        #   Some parameter documentations has been truncated, see
+        #   {Moonbase::Models::SocialLinkedInValue::Data} for more details.
+        #
+        #   The social media profile for the LinkedIn platform
+        #
+        #   @param url [String] The full URL to the LinkedIn profile.
+        #
+        #   @param username [String] The LinkedIn username, including the prefix 'company/' for company pages or 'in/
       end
     end
   end

data/lib/moonbase/models/social_x_field.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class SocialXField < 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::SocialXField::Cardinality]
+      required :cardinality, enum: -> { Moonbase::SocialXField::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., "X Profile").
+      #
+      #   @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., `x_profile`).
+      #
+      #   @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/uri/social_x` for this field.
+      #
+      #   @return [Symbol, :"field/uri/social_x"]
+      required :type, const: :"field/uri/social_x"
+
+      # @!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/uri/social_x")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::SocialXField} for more details.
+      #
+      #   A field that stores X (formerly Twitter) profile information.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param cardinality [Symbol, Moonbase::Models::SocialXField::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., "X Profile").
+      #
+      #   @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/uri/social_x"] The data type of the field. Always `field/uri/social_x` for this field.
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      #
+      # @see Moonbase::Models::SocialXField#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/social_x_value.rb

@@ -3,37 +3,54 @@
 module Moonbase
   module Models
     class SocialXValue < Moonbase::Internal::Type::BaseModel
-      # @!attribute profile
+      # @!attribute data
+      #   Social media profile information including both the full URL and extracted
+      #   username.
       #
-      #   @return [Moonbase::Models::SocialXValue::Profile]
-      required :profile, -> { Moonbase::SocialXValue::Profile }
+      #   @return [Moonbase::Models::SocialXValue::Data]
+      required :data, -> { Moonbase::SocialXValue::Data }
 
       # @!attribute type
       #
       #   @return [Symbol, :"value/uri/social_x"]
       required :type, const: :"value/uri/social_x"
 
-      # @!method initialize(profile:, type: :"value/uri/social_x")
-      #   X (formerly Twitter) username
+      # @!method initialize(data:, type: :"value/uri/social_x")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::SocialXValue} for more details.
+      #
+      #   The social media profile for the X (formerly Twitter) platform
+      #
+      #   @param data [Moonbase::Models::SocialXValue::Data] Social media profile information including both the full URL and extracted usern
       #
-      #   @param profile [Moonbase::Models::SocialXValue::Profile]
       #   @param type [Symbol, :"value/uri/social_x"]
 
-      # @see Moonbase::Models::SocialXValue#profile
-      class Profile < Moonbase::Internal::Type::BaseModel
+      # @see Moonbase::Models::SocialXValue#data
+      class Data < Moonbase::Internal::Type::BaseModel
         # @!attribute url
+        #   The full URL to the X profile, starting with 'https://x.com/'
         #
-        #   @return [String, nil]
-        optional :url, String
+        #   @return [String]
+        required :url, String
 
         # @!attribute username
+        #   The X username, up to 15 characters long, containing only lowercase letters
+        #   (a-z), uppercase letters (A-Z), numbers (0-9), and underscores (\_). Does not
+        #   include the '@' symbol prefix.
         #
-        #   @return [String, nil]
-        optional :username, String
+        #   @return [String]
+        required :username, String
 
-        # @!method initialize(url: nil, username: nil)
-        #   @param url [String]
-        #   @param username [String]
+        # @!method initialize(url:, username:)
+        #   Some parameter documentations has been truncated, see
+        #   {Moonbase::Models::SocialXValue::Data} for more details.
+        #
+        #   Social media profile information including both the full URL and extracted
+        #   username.
+        #
+        #   @param url [String] The full URL to the X profile, starting with 'https://x.com/'
+        #
+        #   @param username [String] The X username, up to 15 characters long, containing only lowercase letters (a-z
       end
     end
   end

data/lib/moonbase/models/stage_field.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class StageField < 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::StageField::Cardinality]
+      required :cardinality, enum: -> { Moonbase::StageField::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 funnel
+      #   The `Funnel` object that defines the available stages for this field.
+      #
+      #   @return [Moonbase::Models::Funnel]
+      required :funnel, -> { Moonbase::Funnel }
+
+      # @!attribute name
+      #   The human-readable name of the field (e.g., "Sales Stage").
+      #
+      #   @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., `sales_stage`).
+      #
+      #   @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/stage` for this field.
+      #
+      #   @return [Symbol, :"field/stage"]
+      required :type, const: :"field/stage"
+
+      # @!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:, funnel:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/stage")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::StageField} for more details.
+      #
+      #   A field that tracks an item's position in a funnel or pipeline workflow.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param cardinality [Symbol, Moonbase::Models::StageField::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 funnel [Moonbase::Models::Funnel] The `Funnel` object that defines the available stages for this field.
+      #
+      #   @param name [String] The human-readable name of the field (e.g., "Sales Stage").
+      #
+      #   @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/stage"] The data type of the field. Always `field/stage` for this field.
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      #
+      # @see Moonbase::Models::StageField#cardinality
+      module Cardinality
+        extend Moonbase::Internal::Type::Enum
+
+        ONE = :one
+        MANY = :many
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end