moonbase-sdk 0.1.0.pre.alpha.1

data/rbi/moonbase/models/program_retrieve_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class ProgramRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::ProgramRetrieveParams, Moonbase::Internal::AnyHash)
+        end
+
+      # Specifies which related objects to include in the response. Valid options are
+      # `activity_metrics` and `program_template`.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Moonbase::ProgramRetrieveParams::Include::OrSymbol]
+          )
+        )
+      end
+      attr_reader :include
+
+      sig do
+        params(
+          include: T::Array[Moonbase::ProgramRetrieveParams::Include::OrSymbol]
+        ).void
+      end
+      attr_writer :include
+
+      sig do
+        params(
+          include: T::Array[Moonbase::ProgramRetrieveParams::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 options are
+        # `activity_metrics` and `program_template`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            include:
+              T::Array[Moonbase::ProgramRetrieveParams::Include::OrSymbol],
+            request_options: Moonbase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Moonbase::ProgramRetrieveParams::Include)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVITY_METRICS =
+          T.let(
+            :activity_metrics,
+            Moonbase::ProgramRetrieveParams::Include::TaggedSymbol
+          )
+        PROGRAM_TEMPLATE =
+          T.let(
+            :program_template,
+            Moonbase::ProgramRetrieveParams::Include::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::ProgramRetrieveParams::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/program_template.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class ProgramTemplate < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::ProgramTemplate, Moonbase::Internal::AnyHash)
+        end
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The body content of the email, which can include Liquid variables.
+      sig { returns(String) }
+      attr_accessor :body
+
+      sig { returns(Moonbase::ProgramTemplate::Links) }
+      attr_reader :links
+
+      sig { params(links: Moonbase::ProgramTemplate::Links::OrHash).void }
+      attr_writer :links
+
+      # The subject line of the email, which can include Liquid variables.
+      sig { returns(String) }
+      attr_accessor :subject
+
+      # String representing the object’s type. Always `program_template` 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 `Program` that uses this template.
+      sig { returns(T.nilable(Moonbase::Program)) }
+      attr_reader :program
+
+      sig { params(program: Moonbase::Program).void }
+      attr_writer :program
+
+      # 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 ProgramTemplate object defines the content of a message sent by a `Program`,
+      # including support for Liquid templating.
+      sig do
+        params(
+          id: String,
+          body: String,
+          links: Moonbase::ProgramTemplate::Links::OrHash,
+          subject: String,
+          created_at: Time,
+          program: Moonbase::Program,
+          updated_at: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        # The body content of the email, which can include Liquid variables.
+        body:,
+        links:,
+        # The subject line of the email, which can include Liquid variables.
+        subject:,
+        # Time at which the object was created, as an RFC 3339 timestamp.
+        created_at: nil,
+        # The `Program` that uses this template.
+        program: nil,
+        # Time at which the object was last updated, as an RFC 3339 timestamp.
+        updated_at: nil,
+        # String representing the object’s type. Always `program_template` for this
+        # object.
+        type: :program_template
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            body: String,
+            links: Moonbase::ProgramTemplate::Links,
+            subject: String,
+            type: Symbol,
+            created_at: Time,
+            program: Moonbase::Program,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Links < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Moonbase::ProgramTemplate::Links, Moonbase::Internal::AnyHash)
+          end
+
+        # The canonical URL for this object.
+        sig { returns(String) }
+        attr_accessor :self_
+
+        # A link to the `Program` using this template.
+        sig { returns(T.nilable(String)) }
+        attr_reader :program
+
+        sig { params(program: String).void }
+        attr_writer :program
+
+        sig { params(self_: String, program: String).returns(T.attached_class) }
+        def self.new(
+          # The canonical URL for this object.
+          self_:,
+          # A link to the `Program` using this template.
+          program: nil
+        )
+        end
+
+        sig { override.returns({ self_: String, program: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/program_template_list_params.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class ProgramTemplateListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Moonbase::ProgramTemplateListParams,
+            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
+      # `program`.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[Moonbase::ProgramTemplateListParams::Include::OrSymbol]
+          )
+        )
+      end
+      attr_reader :include
+
+      sig do
+        params(
+          include:
+            T::Array[Moonbase::ProgramTemplateListParams::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::ProgramTemplateListParams::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
+        # `program`.
+        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::ProgramTemplateListParams::Include::OrSymbol],
+            limit: Integer,
+            request_options: Moonbase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Moonbase::ProgramTemplateListParams::Include)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PROGRAM =
+          T.let(
+            :program,
+            Moonbase::ProgramTemplateListParams::Include::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Moonbase::ProgramTemplateListParams::Include::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/program_template_retrieve_params.rbi

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

data/rbi/moonbase/models/relation_value.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class RelationValue < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::RelationValue, Moonbase::Internal::AnyHash)
+        end
+
+      # An Item represents a single record or row within a Collection. It holds a set of
+      # `values` corresponding to the Collection's `fields`.
+      sig { returns(Moonbase::Item) }
+      attr_reader :item
+
+      sig { params(item: Moonbase::Item).void }
+      attr_writer :item
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Related item reference
+      sig do
+        params(item: Moonbase::Item, type: Symbol).returns(T.attached_class)
+      end
+      def self.new(
+        # An Item represents a single record or row within a Collection. It holds a set of
+        # `values` corresponding to the Collection's `fields`.
+        item:,
+        type: :"value/relation"
+      )
+      end
+
+      sig { override.returns({ item: Moonbase::Item, type: Symbol }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/moonbase/models/single_line_text_value.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class SingleLineTextValue < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::SingleLineTextValue, Moonbase::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :text
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # A single line of text
+      sig { params(text: String, type: Symbol).returns(T.attached_class) }
+      def self.new(text:, type: :"value/text/single_line")
+      end
+
+      sig { override.returns({ text: String, type: Symbol }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/moonbase/models/social_linked_in_value.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class SocialLinkedInValue < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::SocialLinkedInValue, Moonbase::Internal::AnyHash)
+        end
+
+      sig { returns(Moonbase::SocialLinkedInValue::Profile) }
+      attr_reader :profile
+
+      sig do
+        params(profile: Moonbase::SocialLinkedInValue::Profile::OrHash).void
+      end
+      attr_writer :profile
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # LinkedIn profile link
+      sig do
+        params(
+          profile: Moonbase::SocialLinkedInValue::Profile::OrHash,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(profile:, type: :"value/uri/social_linked_in")
+      end
+
+      sig do
+        override.returns(
+          { profile: Moonbase::SocialLinkedInValue::Profile, type: Symbol }
+        )
+      end
+      def to_hash
+      end
+
+      class Profile < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Moonbase::SocialLinkedInValue::Profile,
+              Moonbase::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :username
+
+        sig { params(username: String).void }
+        attr_writer :username
+
+        sig { params(url: String, username: String).returns(T.attached_class) }
+        def self.new(url: nil, username: nil)
+        end
+
+        sig { override.returns({ url: String, username: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/models/social_x_value.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Moonbase
+  module Models
+    class SocialXValue < Moonbase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Moonbase::SocialXValue, Moonbase::Internal::AnyHash)
+        end
+
+      sig { returns(Moonbase::SocialXValue::Profile) }
+      attr_reader :profile
+
+      sig { params(profile: Moonbase::SocialXValue::Profile::OrHash).void }
+      attr_writer :profile
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # X (formerly Twitter) username
+      sig do
+        params(
+          profile: Moonbase::SocialXValue::Profile::OrHash,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(profile:, type: :"value/uri/social_x")
+      end
+
+      sig do
+        override.returns(
+          { profile: Moonbase::SocialXValue::Profile, type: Symbol }
+        )
+      end
+      def to_hash
+      end
+
+      class Profile < Moonbase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Moonbase::SocialXValue::Profile, Moonbase::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :username
+
+        sig { params(username: String).void }
+        attr_writer :username
+
+        sig { params(url: String, username: String).returns(T.attached_class) }
+        def self.new(url: nil, username: nil)
+        end
+
+        sig { override.returns({ url: String, username: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end