paperdrive 0.0.5

data/lib/paperdrive/client/organization_fields.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to OrganizationFields to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields
+    module OrganizationFields
+      include Paperdrive::Parameters
+
+      # [GET] Get all organization fields
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/get_organizationFields
+      # @return [Paperdrive::Response]
+      def all_organization_fields(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'organizationFields', params)
+      end
+
+      # [GET] Get one organization field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/get_organizationFields_id
+      # @return [Paperdrive::Response]
+      def organization_field(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "organizationFields/#{id}", params)
+      end
+
+      # [POST] Add a new organization field
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/post_organizationFields
+      # @return [Paperdrive::Response]
+      def create_organization_field(**args)
+        params = parameters(args) do
+          required_params :name, :field_type
+          optional_params :name, :field_type, :options
+        end
+        request(:post, 'organizationFields', params)
+      end
+
+      # [PUT] Update an organization field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/put_organizationFields_id
+      # @return [Paperdrive::Response]
+      def update_organization_field(id:, **args)
+        params = parameters(args) do
+          required_params :name
+          optional_params :name, :options
+        end
+        request(:put, "organizationFields/#{id}", params)
+      end
+
+      # [DELETE] Delete multiple organization fields in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/delete_organizationFields
+      # @return [Paperdrive::Response]
+      def delete_organization_fields(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'organizationFields', params)
+      end
+
+      # [DELETE] Delete an organization field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationFields/delete_organizationFields_id
+      # @return [Paperdrive::Response]
+      def delete_organization_field(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "organizationFields/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/organization_relationships.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to OrganizationRelationships to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships
+    module OrganizationRelationships
+      include Paperdrive::Parameters
+
+      # [GET] Get all relationships for organization
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/get_organizationRelationships
+      # @return [Paperdrive::Response]
+      def all_organization_relationships(**args)
+        params = parameters(args) do
+          required_params :org_id
+          optional_params :org_id
+        end
+        request(:get, 'organizationRelationships', params)
+      end
+
+      # [GET] Get one organization relationship
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/get_organizationRelationships_id
+      # @return [Paperdrive::Response]
+      def organization_relationship(id:, **args)
+        params = parameters(args) do
+          optional_params :org_id
+        end
+        request(:get, "organizationRelationships/#{id}", params)
+      end
+
+      # [POST] Create an organization relationship
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/post_organizationRelationships
+      # @return [Paperdrive::Response]
+      def create_organization_relationship(**args)
+        params = parameters(args) do
+          required_params :type, :rel_owner_org_id, :rel_linked_org_id
+          optional_params :org_id, :type, :rel_owner_org_id, :rel_linked_org_id
+        end
+        request(:post, 'organizationRelationships', params)
+      end
+
+      # [PUT] Update an organization relationship
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/put_organizationRelationships_id
+      # @return [Paperdrive::Response]
+      def update_organization_relationship(id:, **args)
+        params = parameters(args) do
+          optional_params :org_id, :type, :rel_owner_org_id, :rel_linked_org_id
+        end
+        request(:put, "organizationRelationships/#{id}", params)
+      end
+
+      # [DELETE] Delete an organization relationship
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/OrganizationRelationships/delete_organizationRelationships_id
+      # @return [Paperdrive::Response]
+      def delete_organization_relationship(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "organizationRelationships/#{id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/organizations.rb

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to Organizations to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations
+    module Organizations
+      include Paperdrive::Parameters
+
+      # [GET] Get all organizations
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations
+      # @return [Paperdrive::Response]
+      def all_organizations(**args)
+        params = parameters(args) do
+          optional_params :user_id, :filter_id, :first_char, :start, :limit, :sort
+        end
+        request(:get, 'organizations', params)
+      end
+
+      # [GET] Find organizations by name
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_find
+      # @return [Paperdrive::Response]
+      def find_organizations_by_name(**args)
+        params = parameters(args) do
+          required_params :term
+          optional_params :term, :start, :limit
+        end
+        request(:get, 'organizations/find', params)
+      end
+
+      # [GET] Get details of an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id
+      # @return [Paperdrive::Response]
+      def organization_detail(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "organizations/#{id}", params)
+      end
+
+      # [GET] List activities associated with an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_activities
+      # @return [Paperdrive::Response]
+      def organization_activities(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :done, :exclude
+        end
+        request(:get, "organizations/#{id}/activities", params)
+      end
+
+      # [GET] List deals associated with an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_deals
+      # @return [Paperdrive::Response]
+      def organization_deals(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :status, :sort, :only_primary_association
+        end
+        request(:get, "organizations/#{id}/deals", params)
+      end
+
+      # [GET] List files attached to an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_files
+      # @return [Paperdrive::Response]
+      def organization_files(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit, :include_deleted_files, :sort
+        end
+        request(:get, "organizations/#{id}/files", params)
+      end
+
+      # [GET] List updates about an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_flow
+      # @return [Paperdrive::Response]
+      def organization_updates(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "organizations/#{id}/flow", params)
+      end
+
+      # [GET] List followers of an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_followers
+      # @return [Paperdrive::Response]
+      def organization_followers(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "organizations/#{id}/followers", params)
+      end
+
+      # [GET] List mail messages associated with an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_mailMessages
+      # @return [Paperdrive::Response]
+      def organization_mail_messages(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "organizations/#{id}/mailMessages", params)
+      end
+
+      # [GET] List permitted users
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_permittedUsers
+      # @return [Paperdrive::Response]
+      def organization_permitted_users(id:, **args)
+        params = parameters(args) do
+          optional_params :access_level
+        end
+        request(:get, "organizations/#{id}/permittedUsers", params)
+      end
+
+      # [GET] List persons of an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/get_organizations_id_persons
+      # @return [Paperdrive::Response]
+      def organization_persons(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "organizations/#{id}/persons", params)
+      end
+
+      # [POST] Add an organization
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/post_organizations
+      # @return [Paperdrive::Response]
+      def create_organization(**args)
+        params = parameters(args) do
+          required_params :name
+          optional_params :name, :owner_id, :visible_to, :add_time
+        end
+        request(:post, 'organizations', params)
+      end
+
+      # [POST] Add a follower to an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/post_organizations_id_followers
+      # @return [Paperdrive::Response]
+      def add_follower_to_organization(id:, **args)
+        params = parameters(args) do
+          required_params :user_id
+          optional_params :user_id
+        end
+        request(:post, "organizations/#{id}/followers", params)
+      end
+
+      # [PUT] Update an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/put_organizations_id
+      # @return [Paperdrive::Response]
+      def update_organization(id:, **args)
+        params = parameters(args) do
+          optional_params :name, :owner_id, :visible_to
+        end
+        request(:put, "organizations/#{id}", params)
+      end
+
+      # [PUT] Merge two organizations
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/put_organizations_id_merge
+      # @return [Paperdrive::Response]
+      def merge_organizations(id:, **args)
+        params = parameters(args) do
+          required_params :merge_with_id
+          optional_params :merge_with_id
+        end
+        request(:put, "organizations/#{id}/merge", params)
+      end
+
+      # [DELETE] Delete multiple organizations in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/delete_organizations
+      # @return [Paperdrive::Response]
+      def delete_organizations(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'organizations', params)
+      end
+
+      # [DELETE] Delete an organization
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/delete_organizations_id
+      # @return [Paperdrive::Response]
+      def delete_organization(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "organizations/#{id}", params)
+      end
+
+      # [DELETE] Delete a follower from an organization
+      #
+      # @param [integer] id:
+      # @param [integer] follower_id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/Organizations/delete_organizations_id_followers_follower_id
+      # @return [Paperdrive::Response]
+      def delete_organization_follower(id:, follower_id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "organizations/#{id}/followers/#{follower_id}", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/permission_sets.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to PermissionSets to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/PermissionSets
+    module PermissionSets
+      include Paperdrive::Parameters
+
+      # [GET] Get all permission sets
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PermissionSets/get_permissionSets
+      # @return [Paperdrive::Response]
+      def all_permission_sets(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'permissionSets', params)
+      end
+
+      # [GET] Get one permission set
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PermissionSets/get_permissionSets_id
+      # @return [Paperdrive::Response]
+      def permission_set(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "permissionSets/#{id}", params)
+      end
+
+      # [GET] List permission set assignments
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PermissionSets/get_permissionSets_id_assignments
+      # @return [Paperdrive::Response]
+      def all_permission_set_assignments(id:, **args)
+        params = parameters(args) do
+          optional_params :start, :limit
+        end
+        request(:get, "permissionSets/#{id}/assignments", params)
+      end
+
+      # [POST] Add permission set assignment
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PermissionSets/post_permissionSets_id_assignments
+      # @return [Paperdrive::Response]
+      def create_permission_set_assignment(id:, **args)
+        params = parameters(args) do
+          required_params :user_id
+          optional_params :user_id
+        end
+        request(:post, "permissionSets/#{id}/assignments", params)
+      end
+
+      # [PUT] Update permission set details
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PermissionSets/put_permissionSets_id
+      # @return [Paperdrive::Response]
+      def update_permission_set(id:, **args)
+        params = parameters(args) do
+          required_params :contents
+          optional_params :contents
+        end
+        request(:put, "permissionSets/#{id}", params)
+      end
+
+      # [DELETE] Delete a permission set assignment
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PermissionSets/delete_permissionSets_id_assignments
+      # @return [Paperdrive::Response]
+      def delete_permission_set_assignment(id:, **args)
+        params = parameters(args) do
+          required_params :user_id
+          optional_params :user_id
+        end
+        request(:delete, "permissionSets/#{id}/assignments", params)
+      end
+    end
+  end
+end

data/lib/paperdrive/client/person_fields.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'paperdrive/parameters'
+
+module Paperdrive
+  class Client
+    # Instance methods related to PersonFields to embed into Paperdrive::Client<br>
+    # arguments are compatible with the Pipedribe API.
+    #
+    # @see https://developers.pipedrive.com/docs/api/v1/#!/PersonFields
+    module PersonFields
+      include Paperdrive::Parameters
+
+      # [GET] Get all person fields
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PersonFields/get_personFields
+      # @return [Paperdrive::Response]
+      def all_person_fields(**args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, 'personFields', params)
+      end
+
+      # [GET] Get one person field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PersonFields/get_personFields_id
+      # @return [Paperdrive::Response]
+      def person_field(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:get, "personFields/#{id}", params)
+      end
+
+      # [POST] Add a new person field
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PersonFields/post_personFields
+      # @return [Paperdrive::Response]
+      def create_person_field(**args)
+        params = parameters(args) do
+          required_params :name, :field_type
+          optional_params :name, :field_type, :options
+        end
+        request(:post, 'personFields', params)
+      end
+
+      # [PUT] Update a person field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PersonFields/put_personFields_id
+      # @return [Paperdrive::Response]
+      def update_person_field(id:, **args)
+        params = parameters(args) do
+          required_params :name
+          optional_params :name, :options
+        end
+        request(:put, "personFields/#{id}", params)
+      end
+
+      # [DELETE] Delete multiple person fields in bulk
+      #
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PersonFields/delete_personFields
+      # @return [Paperdrive::Response]
+      def delete_person_fields(**args)
+        params = parameters(args) do
+          required_params :ids
+          optional_params :ids
+        end
+        request(:delete, 'personFields', params)
+      end
+
+      # [DELETE] Delete a person field
+      #
+      # @param [integer] id:
+      # @see https://developers.pipedrive.com/docs/api/v1/#!/PersonFields/delete_personFields_id
+      # @return [Paperdrive::Response]
+      def delete_person_field(id:, **args)
+        params = parameters(args) do
+          optional_params
+        end
+        request(:delete, "personFields/#{id}", params)
+      end
+    end
+  end
+end