paperdrive 0.0.5

data/lib/paperdrive/client/deals.rb

@@ -0,0 +1,335 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Deals to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals
+    module Deals
+      include Paperdrive::Parameters
+
+      # [GET] Get all deals
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals
+      # @return [Paperdrive::Response]
+      def all_deals(**args)
+        params = parameters(args) do
+          optional_params :user_id, :filter_id, :stage_id, :status, :start, :limit, :sort, :owned_by_you
+        end
+        request(:get, 'deals', params)
+      end
+
+      # [GET] Find deals by name
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_find
+      # @return [Paperdrive::Response]
+      def find_deals_by_name(**args)
+        params = parameters(args) do
+          required_params :term
+          optional_params :term, :person_id, :org_id
+        end
+        request(:get, 'deals/find', params)
+      end
+
+      # [GET] Get deals timeline
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_timeline
+      # @return [Paperdrive::Response]
+      def deals_timeline(**args)
+        params = parameters(args) do
+          required_params :start_date, :interval, :amount, :field_key
+          optional_params :start_date, :interval, :amount, :field_key, :user_id, :pipeline_id, :filter_id, :exclude_deals, :totals_convert_currency
+        end
+        request(:get, 'deals/timeline', params)
+      end
+
+      # [GET] Get details of a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id
+      # @return [Paperdrive::Response]
+      def deal_detail(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "deals/#{id}", params)
+      end
+
+      # [GET] List activities associated with a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_activities
+      # @return [Paperdrive::Response]
+      def deal_activities(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :done, :exclude
+        end
+        request(:get, "deals/#{id}/activities", params)
+      end
+
+      # [GET] List files attached to a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_files
+      # @return [Paperdrive::Response]
+      def deal_files(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :include_deleted_files, :sort
+        end
+        request(:get, "deals/#{id}/files", params)
+      end
+
+      # [GET] List updates about a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_flow
+      # @return [Paperdrive::Response]
+      def deal_updates(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "deals/#{id}/flow", params)
+      end
+
+      # [GET] List followers of a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_followers
+      # @return [Paperdrive::Response]
+      def deal_followers(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "deals/#{id}/followers", params)
+      end
+
+      # [GET] List mail messages associated with a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_mailMessages
+      # @return [Paperdrive::Response]
+      def deal_mail_messages(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "deals/#{id}/mailMessages", params)
+      end
+
+      # [GET] List participants of a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_participants
+      # @return [Paperdrive::Response]
+      def deal_participants(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "deals/#{id}/participants", params)
+      end
+
+      # [GET] List permitted users
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_permittedUsers
+      # @return [Paperdrive::Response]
+      def deal_permitted_users(id:, **args)
+        params = parameters(args) do
+          optional_params :access_level
+        end
+        request(:get, "deals/#{id}/permittedUsers", params)
+      end
+
+      # [GET] List all persons associated with a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_persons
+      # @return [Paperdrive::Response]
+      def deal_persons(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "deals/#{id}/persons", params)
+      end
+
+      # [GET] List products attached to a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/get_deals_id_products
+      # @return [Paperdrive::Response]
+      def deal_products(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :include_product_data
+        end
+        request(:get, "deals/#{id}/products", params)
+      end
+
+      # [POST] Add a deal
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/post_deals
+      # @return [Paperdrive::Response]
+      def create_deal(**args)
+        params = parameters(args) do
+          required_params :title
+          optional_params :title, :value, :currency, :user_id, :person_id, :org_id, :stage_id, :status, :probability, :lost_reason, :add_time, :visible_to
+        end
+        request(:post, 'deals', params)
+      end
+
+      # [POST] Duplicate deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/post_deals_id_duplicate
+      # @return [Paperdrive::Response]
+      def duplicate_deal(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:post, "deals/#{id}/duplicate", params)
+      end
+
+      # [POST] Add a follower to a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/post_deals_id_followers
+      # @return [Paperdrive::Response]
+      def add_follower_to_deal(id:, **args)
+        params = parameters(args) do
+          required_params :user_id
+          optional_params :user_id
+        end
+        request(:post, "deals/#{id}/followers", params)
+      end
+
+      # [POST] Add a participant to a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/post_deals_id_participants
+      # @return [Paperdrive::Response]
+      def add_participant_to_deal(id:, **args)
+        params = parameters(args) do
+          required_params :person_id
+          optional_params :person_id
+        end
+        request(:post, "deals/#{id}/participants", params)
+      end
+
+      # [POST] Add a product to the deal, eventually creating a new item called a deal-product.
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/post_deals_id_products
+      # @return [Paperdrive::Response]
+      def add_product_to_deal(id:, **args)
+        params = parameters(args) do
+          required_params :product_id, :item_price, :quantity
+          optional_params :product_id, :item_price, :quantity, :discount_percentage, :duration, :product_variation_id, :comments, :enabled_flag
+        end
+        request(:post, "deals/#{id}/products", params)
+      end
+
+      # [PUT] Update a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/put_deals_id
+      # @return [Paperdrive::Response]
+      def update_deal(id:, **args)
+        params = parameters(args) do
+          optional_params :title, :value, :currency, :user_id, :person_id, :org_id, :stage_id, :status, :probability, :lost_reason, :visible_to
+        end
+        request(:put, "deals/#{id}", params)
+      end
+
+      # [PUT] Merge two deals
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/put_deals_id_merge
+      # @return [Paperdrive::Response]
+      def merge_deals(id:, **args)
+        params = parameters(args) do
+          required_params :merge_with_id
+          optional_params :merge_with_id
+        end
+        request(:put, "deals/#{id}/merge", params)
+      end
+
+      # [PUT] Update product attachment details of the deal-product (a product already attached to a deal)
+      #
+      # @param [integer] id:
+      # @param [integer] deal_product_id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/put_deals_id_products_deal_product_id
+      # @return [Paperdrive::Response]
+      def update_deal_product(id:, deal_product_id:, **args)
+        params = parameters(args) do
+          required_params :item_price, :quantity
+          optional_params :item_price, :quantity, :discount_percentage, :duration, :product_variation_id, :comments, :enabled_flag
+        end
+        request(:put, "deals/#{id}/products/#{deal_product_id}", params)
+      end
+
+      # [DELETE] Delete multiple deals in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/delete_deals
+      # @return [Paperdrive::Response]
+      def delete_deals(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'deals', params)
+      end
+
+      # [DELETE] Delete a deal
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/delete_deals_id
+      # @return [Paperdrive::Response]
+      def delete_deal(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "deals/#{id}", params)
+      end
+
+      # [DELETE] Delete a follower from a deal
+      #
+      # @param [integer] id:
+      # @param [integer] follower_id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/delete_deals_id_followers_follower_id
+      # @return [Paperdrive::Response]
+      def delete_deal_follower(id:, follower_id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "deals/#{id}/followers/#{follower_id}", params)
+      end
+
+      # [DELETE] Delete a participant from a deal
+      #
+      # @param [integer] id:
+      # @param [integer] deal_participant_id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/delete_deals_id_participants_deal_participant_id
+      # @return [Paperdrive::Response]
+      def delete_deal_participants(id:, deal_participant_id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "deals/#{id}/participants/#{deal_participant_id}", params)
+      end
+
+      # [DELETE] Delete an attached product from a deal
+      #
+      # @param [integer] id:
+      # @param [integer] product_attachment_id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Deals/delete_deals_id_products_product_attachment_id
+      # @return [Paperdrive::Response]
+      def delete_deal_product(id:, product_attachment_id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "deals/#{id}/products/#{product_attachment_id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/filters.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Filters to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Filters
+    module Filters
+      include Paperdrive::Parameters
+
+      # [GET] Get all filters
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Filters/get_filters
+      # @return [Paperdrive::Response]
+      def all_filters(**args)
+        params = parameters(args) do
+          optional_params :type
+        end
+        request(:get, 'filters', params)
+      end
+
+      # [GET] Get one filter
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Filters/get_filters_id
+      # @return [Paperdrive::Response]
+      def filter(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "filters/#{id}", params)
+      end
+
+      # [POST] Add a new filter
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Filters/post_filters
+      # @return [Paperdrive::Response]
+      def create_filter(**args)
+        params = parameters(args) do
+          required_params :name, :conditions, :type
+          optional_params :name, :conditions, :type
+        end
+        request(:post, 'filters', params)
+      end
+
+      # [PUT] Update filter
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Filters/put_filters_id
+      # @return [Paperdrive::Response]
+      def update_filter(id:, **args)
+        params = parameters(args) do
+          required_params :conditions
+          optional_params :name, :conditions
+        end
+        request(:put, "filters/#{id}", params)
+      end
+
+      # [DELETE] Delete multiple filters in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Filters/delete_filters
+      # @return [Paperdrive::Response]
+      def delete_filters(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'filters', params)
+      end
+
+      # [DELETE] Delete a filter
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Filters/delete_filters_id
+      # @return [Paperdrive::Response]
+      def delete_filter(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "filters/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/global_messages.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to GlobalMessages to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/GlobalMessages
+    module GlobalMessages
+      include Paperdrive::Parameters
+
+      # [GET] Get global messages
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/GlobalMessages/get_globalMessages
+      # @return [Paperdrive::Response]
+      def all_global_messages(**args)
+        params = parameters(args) do
+          optional_params :limit
+        end
+        request(:get, 'globalMessages', params)
+      end
+
+      # [DELETE] Delete a global message
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/GlobalMessages/delete_globalMessages_id
+      # @return [Paperdrive::Response]
+      def delete_global_message(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "globalMessages/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/mail_messages.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to MailMessages to embed into Paperdrive::Client<br>
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/MailMessages
+    module MailMessages
+      include Paperdrive::Parameters
+
+      # [GET] Get one mail message
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/MailMessages/get_mailbox_mailMessages_id
+      # @return [Paperdrive::Response]
+      def mail_message(id:, **args)
+        params = parameters(args) do
+          optional_params :include_body
+        end
+        request(:get, "mailbox/mailMessages/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/mail_threads.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to MailThreads to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/MailThreads
+    module MailThreads
+      include Paperdrive::Parameters
+
+      # [GET] Get mail threads
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/MailThreads/get_mailbox_mailThreads
+      # @return [Paperdrive::Response]
+      def all_mail_threads(**args)
+        params = parameters(args) do
+          required_params :folder
+          optional_params :folder, :start, :limit
+        end
+        request(:get, 'mailbox/mailThreads', params)
+      end
+
+      # [GET] Get one mail thread
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/MailThreads/get_mailbox_mailThreads_id
+      # @return [Paperdrive::Response]
+      def mail_thread(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "mailbox/mailThreads/#{id}", params)
+      end
+
+      # [GET] Get all mail messages of mail thread
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/MailThreads/get_mailbox_mailThreads_id_mailMessages
+      # @return [Paperdrive::Response]
+      def mail_thread_mail_messages(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "mailbox/mailThreads/#{id}/mailMessages", params)
+      end
+
+      # [PUT] Update mail thread details
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/MailThreads/put_mailbox_mailThreads_id
+      # @return [Paperdrive::Response]
+      def update_mail_thread(id:, **args)
+        params = parameters(args) do
+          optional_params :deal_id, :shared_flag, :read_flag, :archived_flag
+        end
+        request(:put, "mailbox/mailThreads/#{id}", params)
+      end
+
+      # [DELETE] Delete mail thread
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/MailThreads/delete_mailbox_mailThreads_id
+      # @return [Paperdrive::Response]
+      def delete_mail_thread(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "mailbox/mailThreads/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/note_fields.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to NoteFields to embed into Paperdrive::Client
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/NoteFields
+    module NoteFields
+      include Paperdrive::Parameters
+
+      # [GET] fetch all fields for note.
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/NoteFields/get_noteFields
+      # @return [Paperdrive::Response]
+      def all_note_fields(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'noteFields', params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/notes.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Notes to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Notes
+    module Notes
+      include Paperdrive::Parameters
+
+      # [GET] fetch Notes list
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Notes/get_notes
+      # @return [Paperdrive::Response]
+      def all_notes(**args)
+        params = parameters(args) do
+          optional_params :user_id, :deal_id, :person_id, :org_id, :start, :limit, :sort, :start_date, :end_date, :pinned_to_deal_flag, :pinned_to_organization_flag, :pinned_to_person_flag
+        end
+        request(:get, 'notes', params)
+      end
+
+      # [GET] fetch a single note whose ID specified
+      #
+      # @param [integer] id: ID of the note to fetch
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Notes/get_notes_id
+      # @return [Paperdrive::Response]
+      def note_detail(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "notes/#{id}", params)
+      end
+
+      # [POST] create a single Note
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Notes/post_notes
+      # @return [Paperdrive::Response]
+      def create_note(**args)
+        params = parameters(args) do
+          required_params :content
+          optional_params :content, :deal_id, :person_id, :org_id, :add_time, :pinned_to_deal_flag, :pinned_to_organization_flag, :pinned_to_person_flag
+        end
+        request(:post, 'notes', params)
+      end
+
+      # [PUT] update a single note
+      #
+      # @param [integer] id: ID of the note to update
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Notes/put_notes_id
+      # @return [Paperdrive::Response]
+      def edit_note(id:, **args)
+        params = parameters(args) do
+          required_params :content
+          optional_params :content, :deal_id, :person_id, :org_id, :add_time, :pinned_to_deal_flag, :pinned_to_organization_flag, :pinned_to_person_flag
+        end
+        request(:put, "notes/#{id}", params)
+      end
+
+      # [DELETE] delete a single note
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Notes/delete_notes_id
+      # @return [Paperdrive::Response]
+      def delete_note(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "notes/#{id}", params)
+      end
+    end
+  end
+end