paperdrive 0.0.5

data/lib/paperdrive/client/roles.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Roles to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles
+    module Roles
+      include Paperdrive::Parameters
+
+      # [GET] Get all roles
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/get_roles
+      # @return [Paperdrive::Response]
+      def all_roles(**args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, 'roles', params)
+      end
+
+      # [GET] Get one role
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/get_roles_id
+      # @return [Paperdrive::Response]
+      def role(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "roles/#{id}", params)
+      end
+
+      # [GET] List role assignments
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/get_roles_id_assignments
+      # @return [Paperdrive::Response]
+      def role_assignments(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "roles/#{id}/assignments", params)
+      end
+
+      # [GET] List role sub-roles
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/get_roles_id_roles
+      # @return [Paperdrive::Response]
+      def role_sub_roles(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "roles/#{id}/roles", params)
+      end
+
+      # [GET] List role settings
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/get_roles_id_settings
+      # @return [Paperdrive::Response]
+      def role_settings(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "roles/#{id}/settings", params)
+      end
+
+      # [POST] Add a role
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/post_roles
+      # @return [Paperdrive::Response]
+      def create_role(**args)
+        params = parameters(args) do
+          required_params :name
+          optional_params :parent_role_id, :name
+        end
+        request(:post, 'roles', params)
+      end
+
+      # [POST] Add role assignment
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/post_roles_id_assignments
+      # @return [Paperdrive::Response]
+      def create_role_assignment(id:, **args)
+        params = parameters(args) do
+          required_params :user_id
+          optional_params :user_id
+        end
+        request(:post, "roles/#{id}/assignments", params)
+      end
+
+      # [POST] Add or update role setting
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/post_roles_id_settings
+      # @return [Paperdrive::Response]
+      def create_or_update_role_setting(id:, **args)
+        params = parameters(args) do
+          required_params :setting_key, :value
+          optional_params :setting_key, :value
+        end
+        request(:post, "roles/#{id}/settings", params)
+      end
+
+      # [PUT] Update role details
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/put_roles_id
+      # @return [Paperdrive::Response]
+      def update_role_details(id:, **args)
+        params = parameters(args) do
+          optional_params :parent_role_id, :name
+        end
+        request(:put, "roles/#{id}", params)
+      end
+
+      # [DELETE] Delete a role
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/delete_roles_id
+      # @return [Paperdrive::Response]
+      def delete_role(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "roles/#{id}", params)
+      end
+
+      # [DELETE] Delete a role assignment
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Roles/delete_roles_id_assignments
+      # @return [Paperdrive::Response]
+      def delete_role_assignment(id:, **args)
+        params = parameters(args) do
+          required_params :user_id
+          optional_params :user_id
+        end
+        request(:delete, "roles/#{id}/assignments", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/search_results.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to SearchResults to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/SearchResults
+    module SearchResults
+      include Paperdrive::Parameters
+
+      # [GET] Perform a search
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/SearchResults/get_searchResults
+      # @return [Paperdrive::Response]
+      def search(**args)
+        params = parameters(args) do
+          required_params :term
+          optional_params :term, :item_type, :start, :limit, :exact_match
+        end
+        request(:get, 'searchResults', params)
+      end
+
+      # [GET] Perform a search using a specific field value
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/SearchResults/get_searchResults_field
+      # @return [Paperdrive::Response]
+      def specific_search(**args)
+        params = parameters(args) do
+          required_params :term, :field_type, :field_key
+          optional_params :term, :exact_match, :field_type, :field_key, :return_field_key, :return_item_ids, :start, :limit
+        end
+        request(:get, 'searchResults/field', params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/stages.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Stages to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Stages
+    module Stages
+      include Paperdrive::Parameters
+
+      # [GET] Get all stages
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Stages/get_stages
+      # @return [Paperdrive::Response]
+      def all_stages(**args)
+        params = parameters(args) do
+          optional_params :pipeline_id
+        end
+        request(:get, 'stages', params)
+      end
+
+      # [GET] Get one stage
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Stages/get_stages_id
+      # @return [Paperdrive::Response]
+      def stage(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "stages/#{id}", params)
+      end
+
+      # [GET] Get deals in a stage
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Stages/get_stages_id_deals
+      # @return [Paperdrive::Response]
+      def stage_deals(id:, **args)
+        params = parameters(args) do
+          optional_params :filter_id, :user_id, :everyone, :start, :limit
+        end
+        request(:get, "stages/#{id}/deals", params)
+      end
+
+      # [POST] Add a new stage
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Stages/post_stages
+      # @return [Paperdrive::Response]
+      def create_stage(**args)
+        params = parameters(args) do
+          required_params :name, :pipeline_id
+          optional_params :name, :pipeline_id, :deal_probability, :rotten_flag, :rotten_days
+        end
+        request(:post, 'stages', params)
+      end
+
+      # [PUT] Update stage details
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Stages/put_stages_id
+      # @return [Paperdrive::Response]
+      def update_stage(id:, **args)
+        params = parameters(args) do
+          optional_params :name, :pipeline_id, :order_nr, :deal_probability, :rotten_flag, :rotten_days
+        end
+        request(:put, "stages/#{id}", params)
+      end
+
+      # [DELETE] Delete multiple stages in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Stages/delete_stages
+      # @return [Paperdrive::Response]
+      def delete_stages(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'stages', params)
+      end
+
+      # [DELETE] Delete a stage
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Stages/delete_stages_id
+      # @return [Paperdrive::Response]
+      def delete_stage(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "stages/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/user_connections.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to UserConnections to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/UserConnections
+    module UserConnections
+      include Paperdrive::Parameters
+
+      # [GET] Get all user connections
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/UserConnections/get_userConnections
+      # @return [Paperdrive::Response]
+      def all_user_connections(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'userConnections', params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/user_settings.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to UserSettings to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/UserSettings
+    module UserSettings
+      include Paperdrive::Parameters
+
+      # [GET] List settings of authorized user
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/UserSettings/get_userSettings
+      # @return [Paperdrive::Response]
+      def current_user_settings(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'userSettings', params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/users.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Users to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Users
+    module Users
+      include Paperdrive::Parameters
+
+      # [GET] Get all users
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users
+      # @return [Paperdrive::Response]
+      def all_users(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'users', params)
+      end
+
+      # [GET] Find users by name
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_find
+      # @return [Paperdrive::Response]
+      def find_users_by_name(**args)
+        params = parameters(args) do
+          required_params :term
+          optional_params :term, :search_by_email
+        end
+        request(:get, 'users/find', params)
+      end
+
+      # [GET] Get current user data
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_me
+      # @return [Paperdrive::Response]
+      def current_user(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'users/me', params)
+      end
+
+      # [GET] Get one user
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id
+      # @return [Paperdrive::Response]
+      def user(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "users/#{id}", params)
+      end
+
+      # [GET] List and filter activities assigned to a specific user
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_activities
+      # @return [Paperdrive::Response]
+      def user_activities(id:, **args)
+        params = parameters(args) do
+          optional_params :due_date, :type, :start, :limit, :done
+        end
+        request(:get, "users/#{id}/activities", params)
+      end
+
+      # [GET] List blacklisted email addresses of a user
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_blacklistedEmails
+      # @return [Paperdrive::Response]
+      def user_blacklisted_emails(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "users/#{id}/blacklistedEmails", params)
+      end
+
+      # [GET] List followers of a user
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_followers
+      # @return [Paperdrive::Response]
+      def user_followers(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "users/#{id}/followers", params)
+      end
+
+      # [GET] List permission set assignments
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_permissionSetAssignments
+      # @return [Paperdrive::Response]
+      def user_permission_set_assignments(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "users/#{id}/permissionSetAssignments", params)
+      end
+
+      # [GET] List user permissions
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_permissions
+      # @return [Paperdrive::Response]
+      def user_permissions(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "users/#{id}/permissions", params)
+      end
+
+      # [GET] List role assignments
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_roleAssignments
+      # @return [Paperdrive::Response]
+      def user_role_assignments(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "users/#{id}/roleAssignments", params)
+      end
+
+      # [GET] List user role settings
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_roleSettings
+      # @return [Paperdrive::Response]
+      def user_role_settings(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "users/#{id}/roleSettings", params)
+      end
+
+      # [POST] Add a new user
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/post_users
+      # @return [Paperdrive::Response]
+      def create_user(**args)
+        params = parameters(args) do
+          required_params :name, :email, :active_flag
+          optional_params :name, :email, :active_flag
+        end
+        request(:post, 'users', params)
+      end
+
+      # [POST] Add blacklisted email address for a user
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/post_users_id_blacklistedEmails
+      # @return [Paperdrive::Response]
+      def create_user_blacklisted_email(id:, **args)
+        params = parameters(args) do
+          required_params :address
+          optional_params :address
+        end
+        request(:post, "users/#{id}/blacklistedEmails", params)
+      end
+
+      # [POST] Add permission set assignment
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/post_users_id_permissionSetAssignments
+      # @return [Paperdrive::Response]
+      def create_user_permission_set_assignment(id:, **args)
+        params = parameters(args) do
+          required_params :permission_set_id
+          optional_params :permission_set_id
+        end
+        request(:post, "users/#{id}/permissionSetAssignments", params)
+      end
+
+      # [POST] Add role assignment
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/post_users_id_roleAssignments
+      # @return [Paperdrive::Response]
+      def create_user_role_assignment(id:, **args)
+        params = parameters(args) do
+          required_params :role_id
+          optional_params :role_id
+        end
+        request(:post, "users/#{id}/roleAssignments", params)
+      end
+
+      # [PUT] Update user details
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/put_users_id
+      # @return [Paperdrive::Response]
+      def update_user(id:, **args)
+        params = parameters(args) do
+          required_params :active_flag
+          optional_params :active_flag
+        end
+        request(:put, "users/#{id}", params)
+      end
+
+      # [DELETE] Delete a permission set assignment
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/delete_users_id_permissionSetAssignments
+      # @return [Paperdrive::Response]
+      def delete_user_permission_set_assignment(id:, **args)
+        params = parameters(args) do
+          required_params :permission_set_id
+          optional_params :permission_set_id
+        end
+        request(:delete, "users/#{id}/permissionSetAssignments", params)
+      end
+
+      # [DELETE] Delete a role assignment
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Users/delete_users_id_roleAssignments
+      # @return [Paperdrive::Response]
+      def delete_user_role_assignment(id:, **args)
+        params = parameters(args) do
+          required_params :role_id
+          optional_params :role_id
+        end
+        request(:delete, "users/#{id}/roleAssignments", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/webhooks.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Webhooks to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Webhooks
+    module Webhooks
+      include Paperdrive::Parameters
+
+      # [GET] Get all webhooks
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/get_webhooks
+      # @return [Paperdrive::Response]
+      def all_webhooks(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'webhooks', params)
+      end
+
+      # [POST] Create a new webhook
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/post_webhooks
+      # @return [Paperdrive::Response]
+      def create_webhook(**args)
+        params = parameters(args) do
+          required_params :subscription_url, :event_action, :event_object
+          optional_params :subscription_url, :event_action, :event_object, :user_id, :http_auth_user, :http_auth_password
+        end
+        request(:post, 'webhooks', params)
+      end
+
+      # [DELETE] Delete existing webhook
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Webhooks/delete_webhooks_id
+      # @return [Paperdrive::Response]
+      def delete_webhook(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "webhooks/#{id}", params)
+      end
+    end
+  end
+end