Module: Paperdrive::Client::PersonFields
- Includes:
- Parameters
- Included in:
- Paperdrive::Client
- Defined in:
- lib/paperdrive/client/person_fields.rb
Overview
Instance methods related to PersonFields to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.
Instance Method Summary collapse
-
#all_person_fields(**args) ⇒ Paperdrive::Response
- GET
-
Get all person fields.
-
#create_person_field(**args) ⇒ Paperdrive::Response
- POST
-
Add a new person field.
-
#delete_person_field(id:, **args) ⇒ Paperdrive::Response
- DELETE
-
Delete a person field.
-
#delete_person_fields(**args) ⇒ Paperdrive::Response
- DELETE
-
Delete multiple person fields in bulk.
-
#person_field(id:, **args) ⇒ Paperdrive::Response
- GET
-
Get one person field.
-
#update_person_field(id:, **args) ⇒ Paperdrive::Response
- PUT
-
Update a person field.
Instance Method Details
#all_person_fields(**args) ⇒ Paperdrive::Response
- GET
-
Get all person fields
18 19 20 21 22 23 |
# 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 |
#create_person_field(**args) ⇒ Paperdrive::Response
- POST
-
Add a new person field
41 42 43 44 45 46 47 |
# 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_person_field(id:, **args) ⇒ Paperdrive::Response
- DELETE
-
Delete a person field
79 80 81 82 83 84 |
# 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_person_fields(**args) ⇒ Paperdrive::Response
- DELETE
-
Delete multiple person fields in bulk
66 67 68 69 70 71 72 |
# 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 |
#person_field(id:, **args) ⇒ Paperdrive::Response
- GET
-
Get one person field
30 31 32 33 34 35 |
# 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 |
#update_person_field(id:, **args) ⇒ Paperdrive::Response
- PUT
-
Update a person field
54 55 56 57 58 59 60 |
# 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 |