moonbase-sdk 0.1.0.pre.alpha.1

data/rbi/moonbase/resources/inboxes.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class Inboxes
+      # Retrieves the details of an existing inbox.
+      sig do
+        params(
+          id: String,
+          include: Moonbase::InboxRetrieveParams::Include::OrSymbol,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Inbox)
+      end
+      def retrieve(
+        # The ID of the Inbox to retrieve.
+        id,
+        # Specifies which related objects to include in the response. Valid option is
+        # `tagset`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of shared inboxes.
+      sig do
+        params(
+          after: String,
+          before: String,
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Internal::CursorPage[Moonbase::Inbox])
+      end
+      def list(
+        # 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,
+        # 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
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/items.rbi

@@ -0,0 +1,234 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class Items
+      # Creates a new item in a collection.
+      sig do
+        params(
+          collection_id: String,
+          values:
+            T::Hash[
+              Symbol,
+              T.nilable(
+                T.any(
+                  Moonbase::SingleLineTextValue::OrHash,
+                  Moonbase::MultiLineTextValue::OrHash,
+                  Moonbase::IntegerValue::OrHash,
+                  Moonbase::FloatValue::OrHash,
+                  Moonbase::MonetaryValue::OrHash,
+                  Moonbase::PercentageValue::OrHash,
+                  Moonbase::BooleanValue::OrHash,
+                  Moonbase::EmailValue::OrHash,
+                  Moonbase::URLValue::OrHash,
+                  Moonbase::DomainValue::OrHash,
+                  Moonbase::SocialXValue::OrHash,
+                  Moonbase::SocialLinkedInValue::OrHash,
+                  Moonbase::TelephoneNumber::OrHash,
+                  Moonbase::GeoValue::OrHash,
+                  Moonbase::DateValue::OrHash,
+                  Moonbase::DatetimeValue::OrHash,
+                  Moonbase::Choice::OrHash,
+                  Moonbase::FunnelStep::OrHash,
+                  Moonbase::RelationValue,
+                  T::Array[Moonbase::Value]
+                )
+              )
+            ],
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Item)
+      end
+      def create(
+        # The ID of the `Collection` to create the item in.
+        collection_id:,
+        # A hash where keys are the `ref` of a `Field` and values are the data to be set.
+        values:,
+        request_options: {}
+      )
+      end
+
+      # Retrieves the details of an existing item.
+      sig do
+        params(
+          id: String,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Item)
+      end
+      def retrieve(
+        # The ID of the Item to retrieve.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Updates an item.
+      sig do
+        params(
+          id: String,
+          values:
+            T::Hash[
+              Symbol,
+              T.nilable(
+                T.any(
+                  Moonbase::SingleLineTextValue::OrHash,
+                  Moonbase::MultiLineTextValue::OrHash,
+                  Moonbase::IntegerValue::OrHash,
+                  Moonbase::FloatValue::OrHash,
+                  Moonbase::MonetaryValue::OrHash,
+                  Moonbase::PercentageValue::OrHash,
+                  Moonbase::BooleanValue::OrHash,
+                  Moonbase::EmailValue::OrHash,
+                  Moonbase::URLValue::OrHash,
+                  Moonbase::DomainValue::OrHash,
+                  Moonbase::SocialXValue::OrHash,
+                  Moonbase::SocialLinkedInValue::OrHash,
+                  Moonbase::TelephoneNumber::OrHash,
+                  Moonbase::GeoValue::OrHash,
+                  Moonbase::DateValue::OrHash,
+                  Moonbase::DatetimeValue::OrHash,
+                  Moonbase::Choice::OrHash,
+                  Moonbase::FunnelStep::OrHash,
+                  Moonbase::RelationValue,
+                  T::Array[Moonbase::Value]
+                )
+              )
+            ],
+          update_many_strategy:
+            Moonbase::ItemUpdateParams::UpdateManyStrategy::OrSymbol,
+          update_one_strategy:
+            Moonbase::ItemUpdateParams::UpdateOneStrategy::OrSymbol,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Item)
+      end
+      def update(
+        # Path param: The ID of the Item to update.
+        id,
+        # Body param: A hash where keys are the `ref` of a `Field` and values are the new
+        # data to be set.
+        values:,
+        # Header param: Specifies how to update fields that allow multiple values during a
+        # PATCH or update request. Use `replace` (default) to overwrite all existing
+        # values with the new values. Use `preserve` to leave the existing values
+        # unchanged when already present. Use `merge` to merge the new values with
+        # existing values.
+        update_many_strategy: nil,
+        # Header param: Specifies how to update fields with a single (one) value during a
+        # PATCH or update request. Use `replace` (default) to overwrite the existing value
+        # with the new value. Use `preserve` to leave the existing value unchanged if one
+        # is already present.
+        update_one_strategy: nil,
+        request_options: {}
+      )
+      end
+
+      # Permanently deletes an item.
+      sig do
+        params(
+          id: String,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Item)
+      end
+      def delete(
+        # The ID of the Item to delete.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Find and update an existing item, or create a new one.
+      sig do
+        params(
+          collection_id: String,
+          identifiers:
+            T::Hash[
+              Symbol,
+              T.nilable(
+                T.any(
+                  Moonbase::SingleLineTextValue::OrHash,
+                  Moonbase::MultiLineTextValue::OrHash,
+                  Moonbase::IntegerValue::OrHash,
+                  Moonbase::FloatValue::OrHash,
+                  Moonbase::MonetaryValue::OrHash,
+                  Moonbase::PercentageValue::OrHash,
+                  Moonbase::BooleanValue::OrHash,
+                  Moonbase::EmailValue::OrHash,
+                  Moonbase::URLValue::OrHash,
+                  Moonbase::DomainValue::OrHash,
+                  Moonbase::SocialXValue::OrHash,
+                  Moonbase::SocialLinkedInValue::OrHash,
+                  Moonbase::TelephoneNumber::OrHash,
+                  Moonbase::GeoValue::OrHash,
+                  Moonbase::DateValue::OrHash,
+                  Moonbase::DatetimeValue::OrHash,
+                  Moonbase::Choice::OrHash,
+                  Moonbase::FunnelStep::OrHash,
+                  Moonbase::RelationValue,
+                  T::Array[Moonbase::Value]
+                )
+              )
+            ],
+          values:
+            T::Hash[
+              Symbol,
+              T.nilable(
+                T.any(
+                  Moonbase::SingleLineTextValue::OrHash,
+                  Moonbase::MultiLineTextValue::OrHash,
+                  Moonbase::IntegerValue::OrHash,
+                  Moonbase::FloatValue::OrHash,
+                  Moonbase::MonetaryValue::OrHash,
+                  Moonbase::PercentageValue::OrHash,
+                  Moonbase::BooleanValue::OrHash,
+                  Moonbase::EmailValue::OrHash,
+                  Moonbase::URLValue::OrHash,
+                  Moonbase::DomainValue::OrHash,
+                  Moonbase::SocialXValue::OrHash,
+                  Moonbase::SocialLinkedInValue::OrHash,
+                  Moonbase::TelephoneNumber::OrHash,
+                  Moonbase::GeoValue::OrHash,
+                  Moonbase::DateValue::OrHash,
+                  Moonbase::DatetimeValue::OrHash,
+                  Moonbase::Choice::OrHash,
+                  Moonbase::FunnelStep::OrHash,
+                  Moonbase::RelationValue,
+                  T::Array[Moonbase::Value]
+                )
+              )
+            ],
+          update_many_strategy:
+            Moonbase::ItemUpsertParams::UpdateManyStrategy::OrSymbol,
+          update_one_strategy:
+            Moonbase::ItemUpsertParams::UpdateOneStrategy::OrSymbol,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Item)
+      end
+      def upsert(
+        # Body param: The ID of the `Collection` to create the item in.
+        collection_id:,
+        # Body param: A hash where keys are the `ref` of a `Field` and values are used to
+        # identify the item to update. When multiple identifiers are provided, the update
+        # will find items that match any of the identifiers.
+        identifiers:,
+        # Body param: A hash where keys are the `ref` of a `Field` and values are the data
+        # to be set.
+        values:,
+        # Header param: Specifies how to update fields that allow multiple values. Use
+        # `replace` (default) to overwrite all existing values with the new values. Use
+        # `preserve` to leave the existing values unchanged when already present. Use
+        # `merge` to merge the new values with existing values.
+        update_many_strategy: nil,
+        # Header param: Specifies how to update fields that have a single value. Use
+        # `replace` (default) to overwrite the existing value with the new value. Use
+        # `preserve` to leave the existing value unchanged if one is already present.
+        update_one_strategy: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/meetings.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class Meetings
+      # Retrieves the details of an existing meeting.
+      sig do
+        params(
+          id: String,
+          include: T::Array[Moonbase::MeetingRetrieveParams::Include::OrSymbol],
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Meeting)
+      end
+      def retrieve(
+        # The ID of the meeting to retrieve.
+        id,
+        # Specifies which related objects to include in the response. Valid options are
+        # `organizer` and `attendees`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of meetings.
+      sig do
+        params(
+          after: String,
+          before: String,
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Internal::CursorPage[Moonbase::Meeting])
+      end
+      def list(
+        # 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,
+        # 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
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/notes.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class Notes
+      # Retrieves the details of an existing note.
+      sig do
+        params(
+          id: String,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Note)
+      end
+      def retrieve(
+        # The ID of the note to retrieve.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of your notes.
+      sig do
+        params(
+          after: String,
+          before: String,
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Internal::CursorPage[Moonbase::Note])
+      end
+      def list(
+        # 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,
+        # 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
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/program_messages.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class ProgramMessages
+      # Sends a message using a program template.
+      sig do
+        params(
+          person: Moonbase::ProgramMessageCreateParams::Person::OrHash,
+          program_template_id: String,
+          custom_variables: T::Hash[Symbol, T.anything],
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Models::ProgramMessageCreateResponse)
+      end
+      def create(
+        # The person to send the message to.
+        person:,
+        # The ID of the `ProgramTemplate` to use for sending the message.
+        program_template_id:,
+        # Any custom Liquid variables to be interpolated into the message template.
+        custom_variables: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/program_templates.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class ProgramTemplates
+      # Retrieves the details of an existing program template.
+      sig do
+        params(
+          id: String,
+          include:
+            T::Array[
+              Moonbase::ProgramTemplateRetrieveParams::Include::OrSymbol
+            ],
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::ProgramTemplate)
+      end
+      def retrieve(
+        # The ID of the program template to retrieve.
+        id,
+        # Specifies which related objects to include in the response. Valid option is
+        # `program`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of your program templates.
+      sig do
+        params(
+          after: String,
+          before: String,
+          include:
+            T::Array[Moonbase::ProgramTemplateListParams::Include::OrSymbol],
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Internal::CursorPage[Moonbase::ProgramTemplate])
+      end
+      def list(
+        # 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
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/programs.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class Programs
+      # Retrieves the details of an existing program.
+      sig do
+        params(
+          id: String,
+          include: T::Array[Moonbase::ProgramRetrieveParams::Include::OrSymbol],
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Program)
+      end
+      def retrieve(
+        # The ID of the program to retrieve.
+        id,
+        # Specifies which related objects to include in the response. Valid options are
+        # `activity_metrics` and `program_template`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of your marketing programs.
+      sig do
+        params(
+          after: String,
+          before: String,
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Internal::CursorPage[Moonbase::Program])
+      end
+      def list(
+        # 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,
+        # 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
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/tagsets.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class Tagsets
+      # Retrieves the details of an existing tagset.
+      sig do
+        params(
+          id: String,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Tagset)
+      end
+      def retrieve(
+        # The ID of the tagset to retrieve.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Returns a list of your tagsets.
+      sig do
+        params(
+          after: String,
+          before: String,
+          limit: Integer,
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::Internal::CursorPage[Moonbase::Tagset])
+      end
+      def list(
+        # 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,
+        # 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
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/views/items.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class Views
+      class Items
+        # Returns a list of items that are part of the specified view.
+        sig do
+          params(
+            id: String,
+            after: String,
+            before: String,
+            limit: Integer,
+            request_options: Moonbase::RequestOptions::OrHash
+          ).returns(Moonbase::Internal::CursorPage[Moonbase::Item])
+        end
+        def list(
+          # The ID of the view.
+          id,
+          # 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,
+          # 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
+
+        # @api private
+        sig { params(client: Moonbase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/moonbase/resources/views.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Moonbase
+  module Resources
+    class Views
+      sig { returns(Moonbase::Resources::Views::Items) }
+      attr_reader :items
+
+      # Retrieves the details of an existing view.
+      sig do
+        params(
+          id: String,
+          include: T::Array[Moonbase::ViewRetrieveParams::Include::OrSymbol],
+          request_options: Moonbase::RequestOptions::OrHash
+        ).returns(Moonbase::View)
+      end
+      def retrieve(
+        # The ID of the view to retrieve.
+        id,
+        # Specifies which related objects to include in the response. Valid option is
+        # `collection`.
+        include: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Moonbase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/moonbase/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module Moonbase
+  VERSION = T.let(T.unsafe(nil), String)
+end