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

data/rbi/moonbase/models/social_linked_in_value.rbi

@@ -8,58 +8,65 @@ module Moonbase
           T.any(Moonbase::SocialLinkedInValue, Moonbase::Internal::AnyHash)
         end
 
-      sig { returns(Moonbase::SocialLinkedInValue::Profile) }
-      attr_reader :profile
+      # The social media profile for the LinkedIn platform
+      sig { returns(Moonbase::SocialLinkedInValue::Data) }
+      attr_reader :data
 
-      sig do
-        params(profile: Moonbase::SocialLinkedInValue::Profile::OrHash).void
-      end
-      attr_writer :profile
+      sig { params(data: Moonbase::SocialLinkedInValue::Data::OrHash).void }
+      attr_writer :data
 
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # LinkedIn profile link
+      # The social media profile for the LinkedIn platform
       sig do
         params(
-          profile: Moonbase::SocialLinkedInValue::Profile::OrHash,
+          data: Moonbase::SocialLinkedInValue::Data::OrHash,
           type: Symbol
         ).returns(T.attached_class)
       end
-      def self.new(profile:, type: :"value/uri/social_linked_in")
+      def self.new(
+        # The social media profile for the LinkedIn platform
+        data:,
+        type: :"value/uri/social_linked_in"
+      )
       end
 
       sig do
         override.returns(
-          { profile: Moonbase::SocialLinkedInValue::Profile, type: Symbol }
+          { data: Moonbase::SocialLinkedInValue::Data, type: Symbol }
         )
       end
       def to_hash
       end
 
-      class Profile < Moonbase::Internal::Type::BaseModel
+      class Data < Moonbase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Moonbase::SocialLinkedInValue::Profile,
+              Moonbase::SocialLinkedInValue::Data,
               Moonbase::Internal::AnyHash
             )
           end
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :url
-
-        sig { params(url: String).void }
-        attr_writer :url
+        # The full URL to the LinkedIn profile.
+        sig { returns(String) }
+        attr_accessor :url
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :username
-
-        sig { params(username: String).void }
-        attr_writer :username
+        # The LinkedIn username, including the prefix 'company/' for company pages or
+        # 'in/' for personal profiles.
+        sig { returns(String) }
+        attr_accessor :username
 
+        # The social media profile for the LinkedIn platform
         sig { params(url: String, username: String).returns(T.attached_class) }
-        def self.new(url: nil, username: nil)
+        def self.new(
+          # The full URL to the LinkedIn profile.
+          url:,
+          # The LinkedIn username, including the prefix 'company/' for company pages or
+          # 'in/' for personal profiles.
+          username:
+        )
         end
 
         sig { override.returns({ url: String, username: String }) }

data/rbi/moonbase/models/social_x_field.rbi

@@ -0,0 +1,150 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class SocialXField < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::SocialXField, Moonbase::Internal::AnyHash)
+        end
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      sig { returns(Moonbase::SocialXField::Cardinality::TaggedSymbol) }
+      attr_accessor :cardinality
+
+      # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The human-readable name of the field (e.g., "X Profile").
+      sig { returns(String) }
+      attr_accessor :name
+
+      # If `true`, the value of this field is system-managed and cannot be updated via
+      # the API.
+      sig { returns(T::Boolean) }
+      attr_accessor :readonly
+
+      # A unique, stable, machine-readable identifier for the field within its
+      # collection (e.g., `x_profile`).
+      sig { returns(String) }
+      attr_accessor :ref
+
+      # If `true`, this field must have a value.
+      sig { returns(T::Boolean) }
+      attr_accessor :required
+
+      # The data type of the field. Always `field/uri/social_x` for this field.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # If `true`, values for this field must be unique across all items in the
+      # collection.
+      sig { returns(T::Boolean) }
+      attr_accessor :unique
+
+      # 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 field's purpose.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # A field that stores X (formerly Twitter) profile information.
+      sig do
+        params(
+          id: String,
+          cardinality: Moonbase::SocialXField::Cardinality::OrSymbol,
+          created_at: Time,
+          name: String,
+          readonly: T::Boolean,
+          ref: String,
+          required: T::Boolean,
+          unique: T::Boolean,
+          updated_at: Time,
+          description: String,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        # Specifies whether the field can hold a single value (`one`) or multiple values
+        # (`many`).
+        cardinality:,
+        # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+        created_at:,
+        # The human-readable name of the field (e.g., "X Profile").
+        name:,
+        # If `true`, the value of this field is system-managed and cannot be updated via
+        # the API.
+        readonly:,
+        # A unique, stable, machine-readable identifier for the field within its
+        # collection (e.g., `x_profile`).
+        ref:,
+        # If `true`, this field must have a value.
+        required:,
+        # If `true`, values for this field must be unique across all items in the
+        # collection.
+        unique:,
+        # Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+        updated_at:,
+        # An optional, longer-form description of the field's purpose.
+        description: nil,
+        # The data type of the field. Always `field/uri/social_x` for this field.
+        type: :"field/uri/social_x"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            cardinality: Moonbase::SocialXField::Cardinality::TaggedSymbol,
+            created_at: Time,
+            name: String,
+            readonly: T::Boolean,
+            ref: String,
+            required: T::Boolean,
+            type: Symbol,
+            unique: T::Boolean,
+            updated_at: Time,
+            description: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      module Cardinality
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Moonbase::SocialXField::Cardinality) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ONE = T.let(:one, Moonbase::SocialXField::Cardinality::TaggedSymbol)
+        MANY = T.let(:many, Moonbase::SocialXField::Cardinality::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::SocialXField::Cardinality::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/social_x_value.rbi

@@ -8,53 +8,65 @@ module Moonbase
           T.any(Moonbase::SocialXValue, Moonbase::Internal::AnyHash)
         end
 
-      sig { returns(Moonbase::SocialXValue::Profile) }
-      attr_reader :profile
+      # Social media profile information including both the full URL and extracted
+      # username.
+      sig { returns(Moonbase::SocialXValue::Data) }
+      attr_reader :data
 
-      sig { params(profile: Moonbase::SocialXValue::Profile::OrHash).void }
-      attr_writer :profile
+      sig { params(data: Moonbase::SocialXValue::Data::OrHash).void }
+      attr_writer :data
 
       sig { returns(Symbol) }
       attr_accessor :type
 
-      # X (formerly Twitter) username
+      # The social media profile for the X (formerly Twitter) platform
       sig do
         params(
-          profile: Moonbase::SocialXValue::Profile::OrHash,
+          data: Moonbase::SocialXValue::Data::OrHash,
           type: Symbol
         ).returns(T.attached_class)
       end
-      def self.new(profile:, type: :"value/uri/social_x")
+      def self.new(
+        # Social media profile information including both the full URL and extracted
+        # username.
+        data:,
+        type: :"value/uri/social_x"
+      )
       end
 
       sig do
-        override.returns(
-          { profile: Moonbase::SocialXValue::Profile, type: Symbol }
-        )
+        override.returns({ data: Moonbase::SocialXValue::Data, type: Symbol })
       end
       def to_hash
       end
 
-      class Profile < Moonbase::Internal::Type::BaseModel
+      class Data < Moonbase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
-            T.any(Moonbase::SocialXValue::Profile, Moonbase::Internal::AnyHash)
+            T.any(Moonbase::SocialXValue::Data, Moonbase::Internal::AnyHash)
           end
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :url
-
-        sig { params(url: String).void }
-        attr_writer :url
+        # The full URL to the X profile, starting with 'https://x.com/'
+        sig { returns(String) }
+        attr_accessor :url
 
-        sig { returns(T.nilable(String)) }
-        attr_reader :username
-
-        sig { params(username: String).void }
-        attr_writer :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.
+        sig { returns(String) }
+        attr_accessor :username
 
+        # Social media profile information including both the full URL and extracted
+        # username.
         sig { params(url: String, username: String).returns(T.attached_class) }
-        def self.new(url: nil, username: nil)
+        def self.new(
+          # The full URL to the X profile, starting with 'https://x.com/'
+          url:,
+          # 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.
+          username:
+        )
         end
 
         sig { override.returns({ url: String, username: String }) }

data/rbi/moonbase/models/stage_field.rbi

@@ -0,0 +1,161 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class StageField < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::StageField, Moonbase::Internal::AnyHash)
+        end
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      sig { returns(Moonbase::StageField::Cardinality::TaggedSymbol) }
+      attr_accessor :cardinality
+
+      # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The `Funnel` object that defines the available stages for this field.
+      sig { returns(Moonbase::Funnel) }
+      attr_reader :funnel
+
+      sig { params(funnel: Moonbase::Funnel::OrHash).void }
+      attr_writer :funnel
+
+      # The human-readable name of the field (e.g., "Sales Stage").
+      sig { returns(String) }
+      attr_accessor :name
+
+      # If `true`, the value of this field is system-managed and cannot be updated via
+      # the API.
+      sig { returns(T::Boolean) }
+      attr_accessor :readonly
+
+      # A unique, stable, machine-readable identifier for the field within its
+      # collection (e.g., `sales_stage`).
+      sig { returns(String) }
+      attr_accessor :ref
+
+      # If `true`, this field must have a value.
+      sig { returns(T::Boolean) }
+      attr_accessor :required
+
+      # The data type of the field. Always `field/stage` for this field.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # If `true`, values for this field must be unique across all items in the
+      # collection.
+      sig { returns(T::Boolean) }
+      attr_accessor :unique
+
+      # 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 field's purpose.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      # A field that tracks an item's position in a funnel or pipeline workflow.
+      sig do
+        params(
+          id: String,
+          cardinality: Moonbase::StageField::Cardinality::OrSymbol,
+          created_at: Time,
+          funnel: Moonbase::Funnel::OrHash,
+          name: String,
+          readonly: T::Boolean,
+          ref: String,
+          required: T::Boolean,
+          unique: T::Boolean,
+          updated_at: Time,
+          description: String,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        # Specifies whether the field can hold a single value (`one`) or multiple values
+        # (`many`).
+        cardinality:,
+        # Time at which the object was created, as an ISO 8601 timestamp in UTC.
+        created_at:,
+        # The `Funnel` object that defines the available stages for this field.
+        funnel:,
+        # The human-readable name of the field (e.g., "Sales Stage").
+        name:,
+        # If `true`, the value of this field is system-managed and cannot be updated via
+        # the API.
+        readonly:,
+        # A unique, stable, machine-readable identifier for the field within its
+        # collection (e.g., `sales_stage`).
+        ref:,
+        # If `true`, this field must have a value.
+        required:,
+        # If `true`, values for this field must be unique across all items in the
+        # collection.
+        unique:,
+        # Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+        updated_at:,
+        # An optional, longer-form description of the field's purpose.
+        description: nil,
+        # The data type of the field. Always `field/stage` for this field.
+        type: :"field/stage"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            cardinality: Moonbase::StageField::Cardinality::TaggedSymbol,
+            created_at: Time,
+            funnel: Moonbase::Funnel,
+            name: String,
+            readonly: T::Boolean,
+            ref: String,
+            required: T::Boolean,
+            type: Symbol,
+            unique: T::Boolean,
+            updated_at: Time,
+            description: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      module Cardinality
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Moonbase::StageField::Cardinality) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ONE = T.let(:one, Moonbase::StageField::Cardinality::TaggedSymbol)
+        MANY = T.let(:many, Moonbase::StageField::Cardinality::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::StageField::Cardinality::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/subscription.rbi

@@ -0,0 +1,155 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class Subscription < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::Subscription, Moonbase::Internal::AnyHash)
+        end
+
+      # The type of event that will trigger notifications to the endpoint (e.g.,
+      # `activity/item_created`).
+      sig { returns(Moonbase::Subscription::EventType::TaggedSymbol) }
+      attr_accessor :event_type
+
+      # String representing the object’s type. Always `webhook_subscription` for this
+      # object.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # A Webhook Subscription defines which event type should be sent to a specific
+      # webhook endpoint.
+      sig do
+        params(
+          event_type: Moonbase::Subscription::EventType::OrSymbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The type of event that will trigger notifications to the endpoint (e.g.,
+        # `activity/item_created`).
+        event_type:,
+        # String representing the object’s type. Always `webhook_subscription` for this
+        # object.
+        type: :webhook_subscription
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event_type: Moonbase::Subscription::EventType::TaggedSymbol,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The type of event that will trigger notifications to the endpoint (e.g.,
+      # `activity/item_created`).
+      module EventType
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Moonbase::Subscription::EventType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVITY_CALL_OCCURRED =
+          T.let(
+            :"activity/call_occurred",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_FORM_SUBMITTED =
+          T.let(
+            :"activity/form_submitted",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_INBOX_MESSAGE_SENT =
+          T.let(
+            :"activity/inbox_message_sent",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_ITEM_CREATED =
+          T.let(
+            :"activity/item_created",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_ITEM_MENTIONED =
+          T.let(
+            :"activity/item_mentioned",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_ITEM_MERGED =
+          T.let(
+            :"activity/item_merged",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_MEETING_HELD =
+          T.let(
+            :"activity/meeting_held",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_MEETING_SCHEDULED =
+          T.let(
+            :"activity/meeting_scheduled",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_NOTE_CREATED =
+          T.let(
+            :"activity/note_created",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_PROGRAM_MESSAGE_BOUNCED =
+          T.let(
+            :"activity/program_message_bounced",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_PROGRAM_MESSAGE_CLICKED =
+          T.let(
+            :"activity/program_message_clicked",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_PROGRAM_MESSAGE_COMPLAINED =
+          T.let(
+            :"activity/program_message_complained",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_PROGRAM_MESSAGE_FAILED =
+          T.let(
+            :"activity/program_message_failed",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_PROGRAM_MESSAGE_OPENED =
+          T.let(
+            :"activity/program_message_opened",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_PROGRAM_MESSAGE_SENT =
+          T.let(
+            :"activity/program_message_sent",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_PROGRAM_MESSAGE_SHIELDED =
+          T.let(
+            :"activity/program_message_shielded",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+        ACTIVITY_PROGRAM_MESSAGE_UNSUBSCRIBED =
+          T.let(
+            :"activity/program_message_unsubscribed",
+            Moonbase::Subscription::EventType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::Subscription::EventType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end