module Paperdrive::Client::PersonFields
Instance methods related to PersonFields
to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.
Public Instance Methods
- GET
-
Get all person fields
@see developers.pipedrive.com/docs/api/v1/#!/PersonFields/get_personFields @return [Paperdrive::Response]
# File lib/paperdrive/client/person_fields.rb, line 18 def all_person_fields(**args) params = parameters(args) do optional_params end request(:get, 'personFields', params) end
- POST
-
Add a new person field
@see developers.pipedrive.com/docs/api/v1/#!/PersonFields/post_personFields @return [Paperdrive::Response]
# File lib/paperdrive/client/person_fields.rb, line 41 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
- DELETE
-
Delete a person field
@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/PersonFields/delete_personFields_id @return [Paperdrive::Response]
# File lib/paperdrive/client/person_fields.rb, line 79 def delete_person_field(id:, **args) params = parameters(args) do optional_params end request(:delete, "personFields/#{id}", params) end
- DELETE
-
Delete multiple person fields in bulk
@see developers.pipedrive.com/docs/api/v1/#!/PersonFields/delete_personFields @return [Paperdrive::Response]
# File lib/paperdrive/client/person_fields.rb, line 66 def delete_person_fields(**args) params = parameters(args) do required_params :ids optional_params :ids end request(:delete, 'personFields', params) end
- GET
-
Get one person field
@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/PersonFields/get_personFields_id @return [Paperdrive::Response]
# File lib/paperdrive/client/person_fields.rb, line 30 def person_field(id:, **args) params = parameters(args) do optional_params end request(:get, "personFields/#{id}", params) end
- PUT
-
Update a person field
@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/PersonFields/put_personFields_id @return [Paperdrive::Response]
# File lib/paperdrive/client/person_fields.rb, line 54 def update_person_field(id:, **args) params = parameters(args) do required_params :name optional_params :name, :options end request(:put, "personFields/#{id}", params) end