paperdrive 0.0.5

data/lib/paperdrive/client/persons.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Persons to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons
+    module Persons
+      include Paperdrive::Parameters
+
+      # [GET] Get all persons
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons
+      # @return [Paperdrive::Response]
+      def all_persons(**args)
+        params = parameters(args) do
+          optional_params :user_id, :filter_id, :first_char, :start, :limit, :sort
+        end
+        request(:get, 'persons', params)
+      end
+
+      # [GET] Find persons by name
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_find
+      # @return [Paperdrive::Response]
+      def find_persons_by_name(**args)
+        params = parameters(args) do
+          required_params :term
+          optional_params :term, :org_id, :start, :limit, :search_by_email
+        end
+        request(:get, 'persons/find', params)
+      end
+
+      # [GET] Get details of a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id
+      # @return [Paperdrive::Response]
+      def person(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "persons/#{id}", params)
+      end
+
+      # [GET] List activities associated with a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_activities
+      # @return [Paperdrive::Response]
+      def person_activities(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :done, :exclude
+        end
+        request(:get, "persons/#{id}/activities", params)
+      end
+
+      # [GET] List deals associated with a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_deals
+      # @return [Paperdrive::Response]
+      def person_deals(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :status, :sort
+        end
+        request(:get, "persons/#{id}/deals", params)
+      end
+
+      # [GET] List files attached to a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_files
+      # @return [Paperdrive::Response]
+      def person_files(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :include_deleted_files, :sort
+        end
+        request(:get, "persons/#{id}/files", params)
+      end
+
+      # [GET] List updates about a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_flow
+      # @return [Paperdrive::Response]
+      def person_updates(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "persons/#{id}/flow", params)
+      end
+
+      # [GET] List followers of a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_followers
+      # @return [Paperdrive::Response]
+      def person_followers(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "persons/#{id}/followers", params)
+      end
+
+      # [GET] List mail messages associated with a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_mailMessages
+      # @return [Paperdrive::Response]
+      def person_mail_messages(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "persons/#{id}/mailMessages", params)
+      end
+
+      # [GET] List permitted users
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_permittedUsers
+      # @return [Paperdrive::Response]
+      def person_permitted_users(id:, **args)
+        params = parameters(args) do
+          optional_params :access_level
+        end
+        request(:get, "persons/#{id}/permittedUsers", params)
+      end
+
+      # [GET] List products associated with a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/get_persons_id_products
+      # @return [Paperdrive::Response]
+      def person_products(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "persons/#{id}/products", params)
+      end
+
+      # [POST] Add a person
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/post_persons
+      # @return [Paperdrive::Response]
+      def create_person(**args)
+        params = parameters(args) do
+          required_params :name
+          optional_params :name, :owner_id, :org_id, :email, :phone, :visible_to, :add_time
+        end
+        request(:post, 'persons', params)
+      end
+
+      # [POST] Add a follower to a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/post_persons_id_followers
+      # @return [Paperdrive::Response]
+      def create_person_follower(id:, **args)
+        params = parameters(args) do
+          required_params :user_id
+          optional_params :user_id
+        end
+        request(:post, "persons/#{id}/followers", params)
+      end
+
+      # [POST] Add person picture
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/post_persons_id_picture
+      # @return [Paperdrive::Response]
+      # def create_person_picture(id:, **args)
+      #   params = parameters(args) do
+      #     required_params :file
+      #     optional_params :file, :crop_x, :crop_y, :crop_width, :crop_height
+      #   end
+      #   request(:post, "persons/#{id}/picture", params)
+      # end
+
+      # [PUT] Update a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/put_persons_id
+      # @return [Paperdrive::Response]
+      def update_person(id:, **args)
+        params = parameters(args) do
+          optional_params :name, :owner_id, :org_id, :email, :phone, :visible_to
+        end
+        request(:put, "persons/#{id}", params)
+      end
+
+      # [PUT] Merge two persons
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/put_persons_id_merge
+      # @return [Paperdrive::Response]
+      def merge_persons(id:, **args)
+        params = parameters(args) do
+          required_params :merge_with_id
+          optional_params :merge_with_id
+        end
+        request(:put, "persons/#{id}/merge", params)
+      end
+
+      # [DELETE] Delete multiple persons in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/delete_persons
+      # @return [Paperdrive::Response]
+      def delete_persons(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'persons', params)
+      end
+
+      # [DELETE] Delete a person
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/delete_persons_id
+      # @return [Paperdrive::Response]
+      def delete_person(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "persons/#{id}", params)
+      end
+
+      # [DELETE] Delete a follower from a person
+      #
+      # @param [integer] id:
+      # @param [integer] follower_id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/delete_persons_id_followers_follower_id
+      # @return [Paperdrive::Response]
+      def delete_person_follower(id:, follower_id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "persons/#{id}/followers/#{follower_id}", params)
+      end
+
+      # [DELETE] Delete person picture
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Persons/delete_persons_id_picture
+      # @return [Paperdrive::Response]
+      def delete_person_picture(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "persons/#{id}/picture", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/pipelines.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Pipelines to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines
+    module Pipelines
+      include Paperdrive::Parameters
+
+      # [GET] Get all pipelines
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/get_pipelines
+      # @return [Paperdrive::Response]
+      def all_pipelines(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'pipelines', params)
+      end
+
+      # [GET] Get one pipeline
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/get_pipelines_id
+      # @return [Paperdrive::Response]
+      def pipeline(id:, **args)
+        params = parameters(args) do
+          optional_params :totals_convert_currency
+        end
+        request(:get, "pipelines/#{id}", params)
+      end
+
+      # [GET] Get deals conversion rates in pipeline
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/get_pipelines_id_conversion_statistics
+      # @return [Paperdrive::Response]
+      def pipeline_deals_cvr(id:, **args)
+        params = parameters(args) do
+          required_params :start_date, :end_date
+          optional_params :start_date, :end_date, :user_id
+        end
+        request(:get, "pipelines/#{id}/conversion_statistics", params)
+      end
+
+      # [GET] Get deals in a pipeline
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/get_pipelines_id_deals
+      # @return [Paperdrive::Response]
+      def pipeline_deals(id:, **args)
+        params = parameters(args) do
+          optional_params :filter_id, :user_id, :everyone, :stage_id, :start, :limit, :get_summary, :totals_convert_currency
+        end
+        request(:get, "pipelines/#{id}/deals", params)
+      end
+
+      # [GET] Get deals movements in pipeline
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/get_pipelines_id_movement_statistics
+      # @return [Paperdrive::Response]
+      def pipeline_deals_movements(id:, **args)
+        params = parameters(args) do
+          required_params :start_date, :end_date
+          optional_params :start_date, :end_date, :user_id
+        end
+        request(:get, "pipelines/#{id}/movement_statistics", params)
+      end
+
+      # [POST] Add a new pipeline
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/post_pipelines
+      # @return [Paperdrive::Response]
+      def create_pipeline(**args)
+        params = parameters(args) do
+          optional_params :name, :deal_probability, :order_nr, :active
+        end
+        request(:post, 'pipelines', params)
+      end
+
+      # [PUT] Edit a pipeline
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/put_pipelines_id
+      # @return [Paperdrive::Response]
+      def update_pipeline(id:, **args)
+        params = parameters(args) do
+          optional_params :name, :deal_probability, :order_nr, :active
+        end
+        request(:put, "pipelines/#{id}", params)
+      end
+
+      # [DELETE] Delete a pipeline
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Pipelines/delete_pipelines_id
+      # @return [Paperdrive::Response]
+      def delete_pipeline(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "pipelines/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/product_fields.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to ProductFields to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/ProductFields
+    module ProductFields
+      include Paperdrive::Parameters
+
+      # [GET] Get all product fields
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/get_productFields
+      # @return [Paperdrive::Response]
+      def all_product_fields(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'productFields', params)
+      end
+
+      # [GET] Get one product field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/get_productFields_id
+      # @return [Paperdrive::Response]
+      def product_field(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "productFields/#{id}", params)
+      end
+
+      # [POST] Add a new product field
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/post_productFields
+      # @return [Paperdrive::Response]
+      def create_product_field(**args)
+        params = parameters(args) do
+          required_params :name, :field_type
+          optional_params :name, :field_type, :options
+        end
+        request(:post, 'productFields', params)
+      end
+
+      # [PUT] Update a product field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/put_productFields_id
+      # @return [Paperdrive::Response]
+      def update_product_field(id:, **args)
+        params = parameters(args) do
+          required_params :name
+          optional_params :name, :options
+        end
+        request(:put, "productFields/#{id}", params)
+      end
+
+      # [DELETE] Delete multiple product fields in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/delete_productFields
+      # @return [Paperdrive::Response]
+      def delete_product_fields(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'productFields', params)
+      end
+
+      # [DELETE] Delete a product field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/delete_productFields_id
+      # @return [Paperdrive::Response]
+      def delete_product_field(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "productFields/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/products.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Products to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Products
+    module Products
+      include Paperdrive::Parameters
+
+      # [GET] Get all products
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products
+      # @return [Paperdrive::Response]
+      def all_products(**args)
+        params = parameters(args) do
+          optional_params :user_id, :filter_id, :first_char, :start, :limit
+        end
+        request(:get, 'products', params)
+      end
+
+      # [GET] Find products by name
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_find
+      # @return [Paperdrive::Response]
+      def find_products_by_name(**args)
+        params = parameters(args) do
+          required_params :term
+          optional_params :term, :currency, :start, :limit
+        end
+        request(:get, 'products/find', params)
+      end
+
+      # [GET] Get one product
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_id
+      # @return [Paperdrive::Response]
+      def product(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "products/#{id}", params)
+      end
+
+      # [GET] Get deals where a product is attached to
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_id_deals
+      # @return [Paperdrive::Response]
+      def product_deals(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :status
+        end
+        request(:get, "products/#{id}/deals", params)
+      end
+
+      # [GET] List files attached to a product
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_id_files
+      # @return [Paperdrive::Response]
+      def product_files(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :include_deleted_files, :sort
+        end
+        request(:get, "products/#{id}/files", params)
+      end
+
+      # [GET] List followers of a product
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_id_followers
+      # @return [Paperdrive::Response]
+      def product_followers(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "products/#{id}/followers", params)
+      end
+
+      # [GET] List permitted users
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/get_products_id_permittedUsers
+      # @return [Paperdrive::Response]
+      def product_permitted_users(id:, **args)
+        params = parameters(args) do
+          optional_params :access_level
+        end
+        request(:get, "products/#{id}/permittedUsers", params)
+      end
+
+      # [POST] Add a product
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/post_products
+      # @return [Paperdrive::Response]
+      def create_product(**args)
+        params = parameters(args) do
+          required_params :name
+          optional_params :name, :code, :unit, :tax, :active_flag, :visible_to, :owner_id, :prices
+        end
+        request(:post, 'products', params)
+      end
+
+      # [POST] Add a follower to a product
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/post_products_id_followers
+      # @return [Paperdrive::Response]
+      def create_product_follower(id:, **args)
+        params = parameters(args) do
+          required_params :user_id
+          optional_params :user_id
+        end
+        request(:post, "products/#{id}/followers", params)
+      end
+
+      # [PUT] Update a product
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/put_products_id
+      # @return [Paperdrive::Response]
+      def update_product(id:, **args)
+        params = parameters(args) do
+          optional_params :name, :code, :unit, :tax, :active_flag, :visible_to, :owner_id, :prices
+        end
+        request(:put, "products/#{id}", params)
+      end
+
+      # [DELETE] Delete a product
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/delete_products_id
+      # @return [Paperdrive::Response]
+      def delete_product(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "products/#{id}", params)
+      end
+
+      # [DELETE] Delete a follower from a product
+      #
+      # @param [integer] id:
+      # @param [integer] follower_id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Products/delete_products_id_followers_follower_id
+      # @return [Paperdrive::Response]
+      def delete_product_follower(id:, follower_id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "products/#{id}/followers/#{follower_id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/recents.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Recents to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Recents
+    module Recents
+      include Paperdrive::Parameters
+
+      # [GET] Get recents
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Recents/get_recents
+      # @return [Paperdrive::Response]
+      def recents(**args)
+        params = parameters(args) do
+          required_params :since_timestamp
+          optional_params :since_timestamp, :items, :start, :limit
+        end
+        request(:get, 'recents', params)
+      end
+    end
+  end
+end