moonbase-sdk 0.1.0.pre.alpha.1

data/lib/moonbase/resources/items.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Items
+      # Creates a new item in a collection.
+      #
+      # @overload create(collection_id:, values:, request_options: {})
+      #
+      # @param collection_id [String] The ID of the `Collection` to create the item in.
+      #
+      # @param values [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}] A hash where keys are the `ref` of a `Field` and values are the data to be set.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Item]
+      #
+      # @see Moonbase::Models::ItemCreateParams
+      def create(params)
+        parsed, options = Moonbase::ItemCreateParams.dump_request(params)
+        @client.request(method: :post, path: "items", body: parsed, model: Moonbase::Item, options: options)
+      end
+
+      # Retrieves the details of an existing item.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the Item to retrieve.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Item]
+      #
+      # @see Moonbase::Models::ItemRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["items/%1$s", id],
+          model: Moonbase::Item,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::ItemUpdateParams} for more details.
+      #
+      # Updates an item.
+      #
+      # @overload update(id, values:, update_many_strategy: nil, update_one_strategy: nil, request_options: {})
+      #
+      # @param id [String] Path param: The ID of the Item to update.
+      #
+      # @param values [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}] Body param: A hash where keys are the `ref` of a `Field` and values are the new
+      #
+      # @param update_many_strategy [Symbol, Moonbase::Models::ItemUpdateParams::UpdateManyStrategy] Header param: Specifies how to update fields that allow multiple values during a
+      #
+      # @param update_one_strategy [Symbol, Moonbase::Models::ItemUpdateParams::UpdateOneStrategy] Header param: Specifies how to update fields with a single (one) value during a
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Item]
+      #
+      # @see Moonbase::Models::ItemUpdateParams
+      def update(id, params)
+        parsed, options = Moonbase::ItemUpdateParams.dump_request(params)
+        header_params =
+          {update_many_strategy: "update-many-strategy", update_one_strategy: "update-one-strategy"}
+        @client.request(
+          method: :patch,
+          path: ["items/%1$s", id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Moonbase::Item,
+          options: options
+        )
+      end
+
+      # Permanently deletes an item.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The ID of the Item to delete.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Item]
+      #
+      # @see Moonbase::Models::ItemDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["items/%1$s", id],
+          model: Moonbase::Item,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::ItemUpsertParams} for more details.
+      #
+      # Find and update an existing item, or create a new one.
+      #
+      # @overload upsert(collection_id:, identifiers:, values:, update_many_strategy: nil, update_one_strategy: nil, request_options: {})
+      #
+      # @param collection_id [String] Body param: The ID of the `Collection` to create the item in.
+      #
+      # @param identifiers [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}] Body param: A hash where keys are the `ref` of a `Field` and values are used to
+      #
+      # @param values [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}] Body param: A hash where keys are the `ref` of a `Field` and values are the data
+      #
+      # @param update_many_strategy [Symbol, Moonbase::Models::ItemUpsertParams::UpdateManyStrategy] Header param: Specifies how to update fields that allow multiple values. Use `re
+      #
+      # @param update_one_strategy [Symbol, Moonbase::Models::ItemUpsertParams::UpdateOneStrategy] Header param: Specifies how to update fields that have a single value. Use `repl
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Item]
+      #
+      # @see Moonbase::Models::ItemUpsertParams
+      def upsert(params)
+        parsed, options = Moonbase::ItemUpsertParams.dump_request(params)
+        header_params =
+          {update_many_strategy: "update-many-strategy", update_one_strategy: "update-one-strategy"}
+        @client.request(
+          method: :post,
+          path: "items/upsert",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Moonbase::Item,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/meetings.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Meetings
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::MeetingRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing meeting.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID of the meeting to retrieve.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::MeetingRetrieveParams::Include>] Specifies which related objects to include in the response. Valid options are `o
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Meeting]
+      #
+      # @see Moonbase::Models::MeetingRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::MeetingRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["meetings/%1$s", id],
+          query: parsed,
+          model: Moonbase::Meeting,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::MeetingListParams} for more details.
+      #
+      # Returns a list of meetings.
+      #
+      # @overload list(after: nil, before: nil, limit: nil, request_options: {})
+      #
+      # @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      # @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      # @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Internal::CursorPage<Moonbase::Models::Meeting>]
+      #
+      # @see Moonbase::Models::MeetingListParams
+      def list(params = {})
+        parsed, options = Moonbase::MeetingListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "meetings",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::Meeting,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/notes.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Notes
+      # Retrieves the details of an existing note.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the note to retrieve.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Note]
+      #
+      # @see Moonbase::Models::NoteRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["notes/%1$s", id],
+          model: Moonbase::Note,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::NoteListParams} for more details.
+      #
+      # Returns a list of your notes.
+      #
+      # @overload list(after: nil, before: nil, limit: nil, request_options: {})
+      #
+      # @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      # @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      # @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Internal::CursorPage<Moonbase::Models::Note>]
+      #
+      # @see Moonbase::Models::NoteListParams
+      def list(params = {})
+        parsed, options = Moonbase::NoteListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "notes",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::Note,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/program_messages.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class ProgramMessages
+      # Sends a message using a program template.
+      #
+      # @overload create(person:, program_template_id:, custom_variables: nil, request_options: {})
+      #
+      # @param person [Moonbase::Models::ProgramMessageCreateParams::Person] The person to send the message to.
+      #
+      # @param program_template_id [String] The ID of the `ProgramTemplate` to use for sending the message.
+      #
+      # @param custom_variables [Hash{Symbol=>Object}] Any custom Liquid variables to be interpolated into the message template.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::ProgramMessageCreateResponse]
+      #
+      # @see Moonbase::Models::ProgramMessageCreateParams
+      def create(params)
+        parsed, options = Moonbase::ProgramMessageCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "program_messages",
+          body: parsed,
+          model: Moonbase::Models::ProgramMessageCreateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/program_templates.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class ProgramTemplates
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::ProgramTemplateRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing program template.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID of the program template to retrieve.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::ProgramTemplateRetrieveParams::Include>] Specifies which related objects to include in the response. Valid option is `pro
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::ProgramTemplate]
+      #
+      # @see Moonbase::Models::ProgramTemplateRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::ProgramTemplateRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["program_templates/%1$s", id],
+          query: parsed,
+          model: Moonbase::ProgramTemplate,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::ProgramTemplateListParams} for more details.
+      #
+      # Returns a list of your program templates.
+      #
+      # @overload list(after: nil, before: nil, include: nil, limit: nil, request_options: {})
+      #
+      # @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      # @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      # @param include [Array<Symbol, Moonbase::Models::ProgramTemplateListParams::Include>] Specifies which related objects to include in the response. Valid option is `pro
+      #
+      # @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Internal::CursorPage<Moonbase::Models::ProgramTemplate>]
+      #
+      # @see Moonbase::Models::ProgramTemplateListParams
+      def list(params = {})
+        parsed, options = Moonbase::ProgramTemplateListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "program_templates",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::ProgramTemplate,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/programs.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Programs
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::ProgramRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing program.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID of the program to retrieve.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::ProgramRetrieveParams::Include>] Specifies which related objects to include in the response. Valid options are `a
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Program]
+      #
+      # @see Moonbase::Models::ProgramRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::ProgramRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["programs/%1$s", id],
+          query: parsed,
+          model: Moonbase::Program,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::ProgramListParams} for more details.
+      #
+      # Returns a list of your marketing programs.
+      #
+      # @overload list(after: nil, before: nil, limit: nil, request_options: {})
+      #
+      # @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      # @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      # @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Internal::CursorPage<Moonbase::Models::Program>]
+      #
+      # @see Moonbase::Models::ProgramListParams
+      def list(params = {})
+        parsed, options = Moonbase::ProgramListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "programs",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::Program,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/tagsets.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Tagsets
+      # Retrieves the details of an existing tagset.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the tagset to retrieve.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Tagset]
+      #
+      # @see Moonbase::Models::TagsetRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["tagsets/%1$s", id],
+          model: Moonbase::Tagset,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::TagsetListParams} for more details.
+      #
+      # Returns a list of your tagsets.
+      #
+      # @overload list(after: nil, before: nil, limit: nil, request_options: {})
+      #
+      # @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      # @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      # @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Internal::CursorPage<Moonbase::Models::Tagset>]
+      #
+      # @see Moonbase::Models::TagsetListParams
+      def list(params = {})
+        parsed, options = Moonbase::TagsetListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "tagsets",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::Tagset,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/views/items.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Views
+      class Items
+        # Some parameter documentations has been truncated, see
+        # {Moonbase::Models::Views::ItemListParams} for more details.
+        #
+        # Returns a list of items that are part of the specified view.
+        #
+        # @overload list(id, after: nil, before: nil, limit: nil, request_options: {})
+        #
+        # @param id [String] The ID of the view.
+        #
+        # @param after [String] When specified, returns results starting immediately after the item identified b
+        #
+        # @param before [String] When specified, returns results starting immediately before the item identified
+        #
+        # @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+        #
+        # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Moonbase::Internal::CursorPage<Moonbase::Models::Item>]
+        #
+        # @see Moonbase::Models::Views::ItemListParams
+        def list(id, params = {})
+          parsed, options = Moonbase::Views::ItemListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["views/%1$s/items", id],
+            query: parsed,
+            page: Moonbase::Internal::CursorPage,
+            model: Moonbase::Item,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Moonbase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/moonbase/resources/views.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Views
+      # @return [Moonbase::Resources::Views::Items]
+      attr_reader :items
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::ViewRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing view.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID of the view to retrieve.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::ViewRetrieveParams::Include>] Specifies which related objects to include in the response. Valid option is `col
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::View]
+      #
+      # @see Moonbase::Models::ViewRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::ViewRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["views/%1$s", id],
+          query: parsed,
+          model: Moonbase::View,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+        @items = Moonbase::Resources::Views::Items.new(client: client)
+      end
+    end
+  end
+end

data/lib/moonbase/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Moonbase
+  VERSION = "0.1.0.pre.alpha.1"
+end