moonbase-sdk 0.1.0.pre.alpha.1

data/lib/moonbase/resources/activities.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Activities
+      # Retrieves the details of an existing activity.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the Activity to retrieve.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Activity::ActivityCallOccurred, Moonbase::Models::Activity::ActivityFormSubmitted, Moonbase::Models::Activity::ActivityInboxMessageSent, Moonbase::Models::Activity::ActivityItemCreated, Moonbase::Models::Activity::ActivityItemMentioned, Moonbase::Models::Activity::ActivityMeetingHeld, Moonbase::Models::Activity::ActivityMeetingScheduled, Moonbase::Models::Activity::ActivityNoteCreated, Moonbase::Models::Activity::ActivityProgramMessageBounced, Moonbase::Models::Activity::ActivityProgramMessageClicked, Moonbase::Models::Activity::ActivityProgramMessageComplained, Moonbase::Models::Activity::ActivityProgramMessageFailed, Moonbase::Models::Activity::ActivityProgramMessageOpened, Moonbase::Models::Activity::ActivityProgramMessageSent, Moonbase::Models::Activity::ActivityProgramMessageShielded, Moonbase::Models::Activity::ActivityProgramMessageUnsubscribed]
+      #
+      # @see Moonbase::Models::ActivityRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["activities/%1$s", id],
+          model: Moonbase::Activity,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::ActivityListParams} for more details.
+      #
+      # Returns a list of activities.
+      #
+      # @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::Activity::ActivityCallOccurred, Moonbase::Models::Activity::ActivityFormSubmitted, Moonbase::Models::Activity::ActivityInboxMessageSent, Moonbase::Models::Activity::ActivityItemCreated, Moonbase::Models::Activity::ActivityItemMentioned, Moonbase::Models::Activity::ActivityMeetingHeld, Moonbase::Models::Activity::ActivityMeetingScheduled, Moonbase::Models::Activity::ActivityNoteCreated, Moonbase::Models::Activity::ActivityProgramMessageBounced, Moonbase::Models::Activity::ActivityProgramMessageClicked, Moonbase::Models::Activity::ActivityProgramMessageComplained, Moonbase::Models::Activity::ActivityProgramMessageFailed, Moonbase::Models::Activity::ActivityProgramMessageOpened, Moonbase::Models::Activity::ActivityProgramMessageSent, Moonbase::Models::Activity::ActivityProgramMessageShielded, Moonbase::Models::Activity::ActivityProgramMessageUnsubscribed>]
+      #
+      # @see Moonbase::Models::ActivityListParams
+      def list(params = {})
+        parsed, options = Moonbase::ActivityListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "activities",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::Activity,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/calls.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Calls
+      # Logs a phone call.
+      #
+      # @overload create(direction:, participants:, provider:, provider_id:, start_at:, status:, answered_at: nil, end_at: nil, provider_metadata: nil, request_options: {})
+      #
+      # @param direction [Symbol, Moonbase::Models::CallCreateParams::Direction] The direction of the call, either `incoming` or `outgoing`.
+      #
+      # @param participants [Array<Moonbase::Models::CallCreateParams::Participant>] An array of participants involved in the call.
+      #
+      # @param provider [String] The name of the phone provider that handled the call (e.g., `openphone`).
+      #
+      # @param provider_id [String] The unique identifier for the call from the provider's system.
+      #
+      # @param start_at [Time] The time the call started, as an RFC 3339 timestamp.
+      #
+      # @param status [Symbol, Moonbase::Models::CallCreateParams::Status] The status of the call.
+      #
+      # @param answered_at [Time] The time the call was answered, as an RFC 3339 timestamp.
+      #
+      # @param end_at [Time] The time the call ended, as an RFC 3339 timestamp.
+      #
+      # @param provider_metadata [Hash{Symbol=>Object}] A hash of additional metadata from the provider.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Call]
+      #
+      # @see Moonbase::Models::CallCreateParams
+      def create(params)
+        parsed, options = Moonbase::CallCreateParams.dump_request(params)
+        @client.request(method: :post, path: "calls", body: parsed, model: Moonbase::Call, options: options)
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/collections/fields.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Collections
+      class Fields
+        # Retrieves the details of a field in a collection.
+        #
+        # @overload retrieve(id, collection_id:, request_options: {})
+        #
+        # @param id [String] The ID or `ref` of the Field to retrieve.
+        #
+        # @param collection_id [String] The ID or `ref` of the Collection the field belongs to.
+        #
+        # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Moonbase::Models::Field]
+        #
+        # @see Moonbase::Models::Collections::FieldRetrieveParams
+        def retrieve(id, params)
+          parsed, options = Moonbase::Collections::FieldRetrieveParams.dump_request(params)
+          collection_id =
+            parsed.delete(:collection_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["collections/%1$s/fields/%2$s", collection_id, id],
+            model: Moonbase::Field,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Moonbase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/moonbase/resources/collections.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Collections
+      # @return [Moonbase::Resources::Collections::Fields]
+      attr_reader :fields
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::CollectionRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing collection.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID or `ref` of the Collection to retrieve.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::CollectionRetrieveParams::Include>] Specifies which related objects to include in the response. Valid options are `f
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Collection]
+      #
+      # @see Moonbase::Models::CollectionRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::CollectionRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["collections/%1$s", id],
+          query: parsed,
+          model: Moonbase::Collection,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::CollectionListParams} for more details.
+      #
+      # Returns a list of your collections.
+      #
+      # @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::Collection>]
+      #
+      # @see Moonbase::Models::CollectionListParams
+      def list(params = {})
+        parsed, options = Moonbase::CollectionListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "collections",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::Collection,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+        @fields = Moonbase::Resources::Collections::Fields.new(client: client)
+      end
+    end
+  end
+end

data/lib/moonbase/resources/files.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Files
+      # Retrieves the details of an existing file.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the File to retrieve.
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::MoonbaseFile]
+      #
+      # @see Moonbase::Models::FileRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["files/%1$s", id],
+          model: Moonbase::MoonbaseFile,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::FileListParams} for more details.
+      #
+      # Returns a list of files that you have uploaded.
+      #
+      # @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::MoonbaseFile>]
+      #
+      # @see Moonbase::Models::FileListParams
+      def list(params = {})
+        parsed, options = Moonbase::FileListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "files",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::MoonbaseFile,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/forms.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Forms
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::FormRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing form.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID of the Form to retrieve.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::FormRetrieveParams::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::Form]
+      #
+      # @see Moonbase::Models::FormRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::FormRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["forms/%1$s", id],
+          query: parsed,
+          model: Moonbase::Form,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::FormListParams} for more details.
+      #
+      # Returns a list of your forms.
+      #
+      # @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::FormListParams::Include>] Specifies which related objects to include in the response. Valid option is `col
+      #
+      # @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::Form>]
+      #
+      # @see Moonbase::Models::FormListParams
+      def list(params = {})
+        parsed, options = Moonbase::FormListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "forms",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::Form,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/inbox_conversations.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class InboxConversations
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::InboxConversationRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing conversation.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID of the Conversation to retrieve.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::InboxConversationRetrieveParams::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::InboxConversation]
+      #
+      # @see Moonbase::Models::InboxConversationRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::InboxConversationRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["inbox_conversations/%1$s", id],
+          query: parsed,
+          model: Moonbase::InboxConversation,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::InboxConversationListParams} for more details.
+      #
+      # Returns a list of your conversations.
+      #
+      # @overload list(after: nil, before: nil, inbox: 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 inbox [Array<String>] Filter conversations by one or more inbox IDs.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::InboxConversationListParams::Include>] Specifies which related objects to include in the response. Valid options are `a
+      #
+      # @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::InboxConversation>]
+      #
+      # @see Moonbase::Models::InboxConversationListParams
+      def list(params = {})
+        parsed, options = Moonbase::InboxConversationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "inbox_conversations",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::InboxConversation,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/inbox_messages.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class InboxMessages
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::InboxMessageRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing message.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID of the Message to retrieve.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::InboxMessageRetrieveParams::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::EmailMessage]
+      #
+      # @see Moonbase::Models::InboxMessageRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::InboxMessageRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["inbox_messages/%1$s", id],
+          query: parsed,
+          model: Moonbase::EmailMessage,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::InboxMessageListParams} for more details.
+      #
+      # Returns a list of messages.
+      #
+      # @overload list(after: nil, before: nil, conversation: nil, inbox: 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 conversation [Array<String>] Filter messages by one or more conversation IDs.
+      #
+      # @param inbox [Array<String>] Filter messages by one or more inbox IDs.
+      #
+      # @param include [Array<Symbol, Moonbase::Models::InboxMessageListParams::Include>] Specifies which related objects to include in the response. Valid options are `a
+      #
+      # @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::EmailMessage>]
+      #
+      # @see Moonbase::Models::InboxMessageListParams
+      def list(params = {})
+        parsed, options = Moonbase::InboxMessageListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "inbox_messages",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::EmailMessage,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/moonbase/resources/inboxes.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Resources
+    class Inboxes
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::InboxRetrieveParams} for more details.
+      #
+      # Retrieves the details of an existing inbox.
+      #
+      # @overload retrieve(id, include: nil, request_options: {})
+      #
+      # @param id [String] The ID of the Inbox to retrieve.
+      #
+      # @param include [Symbol, Moonbase::Models::InboxRetrieveParams::Include] Specifies which related objects to include in the response. Valid option is `tag
+      #
+      # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Moonbase::Models::Inbox]
+      #
+      # @see Moonbase::Models::InboxRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Moonbase::InboxRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["inboxes/%1$s", id],
+          query: parsed.transform_keys(include: "include[]"),
+          model: Moonbase::Inbox,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Moonbase::Models::InboxListParams} for more details.
+      #
+      # Returns a list of shared inboxes.
+      #
+      # @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::Inbox>]
+      #
+      # @see Moonbase::Models::InboxListParams
+      def list(params = {})
+        parsed, options = Moonbase::InboxListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "inboxes",
+          query: parsed,
+          page: Moonbase::Internal::CursorPage,
+          model: Moonbase::Inbox,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Moonbase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end