moonbase-sdk 0.1.0.pre.alpha.1

data/rbi/moonbase/models/form.rbi

@@ -0,0 +1,161 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class Form < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Moonbase::Form, Moonbase::Internal::AnyHash) }
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The `Collection` that submissions to this form are saved to.
+      sig { returns(Moonbase::Collection) }
+      attr_reader :collection
+
+      sig { params(collection: Moonbase::Collection::OrHash).void }
+      attr_writer :collection
+
+      sig { returns(Moonbase::Form::Links) }
+      attr_reader :links
+
+      sig { params(links: Moonbase::Form::Links::OrHash).void }
+      attr_writer :links
+
+      # The name of the form, used as the title on its public page.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # String representing the object’s type. Always `form` for this object.
+      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
+
+      # `true` if the form is available at a public URL.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :pages_enabled
+
+      sig { params(pages_enabled: T::Boolean).void }
+      attr_writer :pages_enabled
+
+      # The public URL for the form, if `pages_enabled` is `true`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :pages_url
+
+      sig { params(pages_url: String).void }
+      attr_writer :pages_url
+
+      # An optional URL to redirect users to after a successful submission.
+      sig { returns(T.nilable(String)) }
+      attr_reader :redirect_url
+
+      sig { params(redirect_url: String).void }
+      attr_writer :redirect_url
+
+      # 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 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.
+      sig do
+        params(
+          id: String,
+          collection: Moonbase::Collection::OrHash,
+          links: Moonbase::Form::Links::OrHash,
+          name: String,
+          created_at: Time,
+          pages_enabled: T::Boolean,
+          pages_url: String,
+          redirect_url: String,
+          updated_at: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        # The `Collection` that submissions to this form are saved to.
+        collection:,
+        links:,
+        # The name of the form, used as the title on its public page.
+        name:,
+        # Time at which the object was created, as an RFC 3339 timestamp.
+        created_at: nil,
+        # `true` if the form is available at a public URL.
+        pages_enabled: nil,
+        # The public URL for the form, if `pages_enabled` is `true`.
+        pages_url: nil,
+        # An optional URL to redirect users to after a successful submission.
+        redirect_url: nil,
+        # Time at which the object was last updated, as an RFC 3339 timestamp.
+        updated_at: nil,
+        # String representing the object’s type. Always `form` for this object.
+        type: :form
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            collection: Moonbase::Collection,
+            links: Moonbase::Form::Links,
+            name: String,
+            type: Symbol,
+            created_at: Time,
+            pages_enabled: T::Boolean,
+            pages_url: String,
+            redirect_url: String,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Links < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Moonbase::Form::Links, Moonbase::Internal::AnyHash)
+          end
+
+        # The canonical URL for this object.
+        sig { returns(String) }
+        attr_accessor :self_
+
+        # A link to the `Collection` where form submissions are saved.
+        sig { returns(T.nilable(String)) }
+        attr_reader :collection
+
+        sig { params(collection: String).void }
+        attr_writer :collection
+
+        sig do
+          params(self_: String, collection: String).returns(T.attached_class)
+        end
+        def self.new(
+          # The canonical URL for this object.
+          self_:,
+          # A link to the `Collection` where form submissions are saved.
+          collection: nil
+        )
+        end
+
+        sig { override.returns({ self_: String, collection: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/form_list_params.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class FormListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::FormListParams, 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
+
+      # Specifies which related objects to include in the response. Valid option is
+      # `collection.fields`.
+      sig do
+        returns(
+          T.nilable(T::Array[Moonbase::FormListParams::Include::OrSymbol])
+        )
+      end
+      attr_reader :include
+
+      sig do
+        params(
+          include: T::Array[Moonbase::FormListParams::Include::OrSymbol]
+        ).void
+      end
+      attr_writer :include
+
+      # Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      # to 20 if not specified.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          include: T::Array[Moonbase::FormListParams::Include::OrSymbol],
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # When specified, returns results starting immediately after the item identified
+        # by this cursor. Use the cursor value from the previous response's metadata to
+        # fetch the next page of results.
+        after: nil,
+        # When specified, returns results starting immediately before the item identified
+        # by this cursor. Use the cursor value from the response's metadata to fetch the
+        # previous page of results.
+        before: nil,
+        # Specifies which related objects to include in the response. Valid option is
+        # `collection.fields`.
+        include: nil,
+        # Maximum number of items to return per page. Must be between 1 and 100. Defaults
+        # to 20 if not specified.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            include: T::Array[Moonbase::FormListParams::Include::OrSymbol],
+            limit: Integer,
+            request_options: Moonbase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Moonbase::FormListParams::Include) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        COLLECTION_FIELDS =
+          T.let(
+            :"collection.fields",
+            Moonbase::FormListParams::Include::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::FormListParams::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/form_retrieve_params.rbi

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

data/rbi/moonbase/models/funnel_step.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class FunnelStep < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::FunnelStep, Moonbase::Internal::AnyHash)
+        end
+
+      sig { returns(Moonbase::FunnelStep::Step) }
+      attr_reader :step
+
+      sig { params(step: Moonbase::FunnelStep::Step::OrHash).void }
+      attr_writer :step
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Funnel step value
+      sig do
+        params(step: Moonbase::FunnelStep::Step::OrHash, type: Symbol).returns(
+          T.attached_class
+        )
+      end
+      def self.new(step:, type: :"value/funnel_step")
+      end
+
+      sig do
+        override.returns({ step: Moonbase::FunnelStep::Step, type: Symbol })
+      end
+      def to_hash
+      end
+
+      class Step < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Moonbase::FunnelStep::Step, Moonbase::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig do
+          params(id: String, name: String, type: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(id:, name: nil, type: :funnel_step)
+        end
+
+        sig { override.returns({ id: String, type: Symbol, name: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/geo_value.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class GeoValue < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Moonbase::GeoValue, Moonbase::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :geo
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Geographic coordinate value
+      sig { params(geo: String, type: Symbol).returns(T.attached_class) }
+      def self.new(geo:, type: :"value/geo")
+      end
+
+      sig { override.returns({ geo: String, type: Symbol }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/moonbase/models/inbox.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class Inbox < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Moonbase::Inbox, Moonbase::Internal::AnyHash) }
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Moonbase::Inbox::Links) }
+      attr_reader :links
+
+      sig { params(links: Moonbase::Inbox::Links::OrHash).void }
+      attr_writer :links
+
+      # The display name of the inbox.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # String representing the object’s type. Always `inbox` for this object.
+      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
+
+      # The `Tagset` associated with this inbox, which defines the tags available for
+      # its conversations.
+      sig { returns(T.nilable(Moonbase::Tagset)) }
+      attr_reader :tagset
+
+      sig { params(tagset: Moonbase::Tagset::OrHash).void }
+      attr_writer :tagset
+
+      # 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
+
+      # The Inbox object represents a shared inbox for receiving and sending messages.
+      sig do
+        params(
+          id: String,
+          links: Moonbase::Inbox::Links::OrHash,
+          name: String,
+          created_at: Time,
+          tagset: Moonbase::Tagset::OrHash,
+          updated_at: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        links:,
+        # The display name of the inbox.
+        name:,
+        # Time at which the object was created, as an RFC 3339 timestamp.
+        created_at: nil,
+        # The `Tagset` associated with this inbox, which defines the tags available for
+        # its conversations.
+        tagset: nil,
+        # Time at which the object was last updated, as an RFC 3339 timestamp.
+        updated_at: nil,
+        # String representing the object’s type. Always `inbox` for this object.
+        type: :inbox
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            links: Moonbase::Inbox::Links,
+            name: String,
+            type: Symbol,
+            created_at: Time,
+            tagset: Moonbase::Tagset,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Links < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Moonbase::Inbox::Links, Moonbase::Internal::AnyHash)
+          end
+
+        # The canonical URL for this object.
+        sig { returns(String) }
+        attr_accessor :self_
+
+        # A link to the `Tagset` for this inbox.
+        sig { returns(T.nilable(String)) }
+        attr_reader :tagset
+
+        sig { params(tagset: String).void }
+        attr_writer :tagset
+
+        sig { params(self_: String, tagset: String).returns(T.attached_class) }
+        def self.new(
+          # The canonical URL for this object.
+          self_:,
+          # A link to the `Tagset` for this inbox.
+          tagset: nil
+        )
+        end
+
+        sig { override.returns({ self_: String, tagset: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end