Module: Paperdrive::Client::Persons

Includes:
Parameters
Included in:
Paperdrive::Client
Defined in:
lib/paperdrive/client/persons.rb

Overview

Instance methods related to Persons to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.

See Also:

Instance Method Summary collapse

Instance Method Details

#all_persons(**args) ⇒ Paperdrive::Response

GET

Get all persons

Returns:

See Also:



18
19
20
21
22
23
 
# File 'lib/paperdrive/client/persons.rb', line 18

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

#create_person(**args) ⇒ Paperdrive::Response

POST

Add a person

Returns:

See Also:



149
150
151
152
153
154
155
 
# File 'lib/paperdrive/client/persons.rb', line 149

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

#create_person_follower(id:, **args) ⇒ Paperdrive::Response

POST

Add a follower to a person

Parameters:

  • id: (integer)

Returns:

See Also:



162
163
164
165
166
167
168
 
# File 'lib/paperdrive/client/persons.rb', line 162

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

#delete_person(id:, **args) ⇒ Paperdrive::Response

DELETE

Delete a person

Parameters:

  • id: (integer)

Returns:

See Also:



225
226
227
228
229
230
 
# File 'lib/paperdrive/client/persons.rb', line 225

def delete_person(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "persons/#{id}", params)
end

#delete_person_follower(id:, follower_id:, **args) ⇒ Paperdrive::Response

DELETE

Delete a follower from a person

Parameters:

  • id: (integer)
  • follower_id: (integer)

Returns:

See Also:



238
239
240
241
242
243
 
# File 'lib/paperdrive/client/persons.rb', line 238

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_person_picture(id:, **args) ⇒ Paperdrive::Response

DELETE

Delete person picture

Parameters:

  • id: (integer)

Returns:

See Also:



250
251
252
253
254
255
 
# File 'lib/paperdrive/client/persons.rb', line 250

def delete_person_picture(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "persons/#{id}/picture", params)
end

#delete_persons(**args) ⇒ Paperdrive::Response

DELETE

Delete multiple persons in bulk

Returns:

See Also:



212
213
214
215
216
217
218
 
# File 'lib/paperdrive/client/persons.rb', line 212

def delete_persons(**args)
  params = parameters(args) do
    required_params :ids
    optional_params :ids
  end
  request(:delete, 'persons', params)
end

#find_persons_by_name(**args) ⇒ Paperdrive::Response

GET

Find persons by name

Returns:

See Also:



29
30
31
32
33
34
35
 
# File 'lib/paperdrive/client/persons.rb', line 29

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

#merge_persons(id:, **args) ⇒ Paperdrive::Response

PUT

Merge two persons

Parameters:

  • id: (integer)

Returns:

See Also:



200
201
202
203
204
205
206
 
# File 'lib/paperdrive/client/persons.rb', line 200

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

#person(id:, **args) ⇒ Paperdrive::Response

GET

Get details of a person

Parameters:

  • id: (integer)

Returns:

See Also:



42
43
44
45
46
47
 
# File 'lib/paperdrive/client/persons.rb', line 42

def person(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "persons/#{id}", params)
end

#person_activities(id:, **args) ⇒ Paperdrive::Response

GET

List activities associated with a person

Parameters:

  • id: (integer)

Returns:

See Also:



54
55
56
57
58
59
 
# File 'lib/paperdrive/client/persons.rb', line 54

def person_activities(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit, :done, :exclude
  end
  request(:get, "persons/#{id}/activities", params)
end

#person_deals(id:, **args) ⇒ Paperdrive::Response

GET

List deals associated with a person

Parameters:

  • id: (integer)

Returns:

See Also:



66
67
68
69
70
71
 
# File 'lib/paperdrive/client/persons.rb', line 66

def person_deals(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit, :status, :sort
  end
  request(:get, "persons/#{id}/deals", params)
end

#person_files(id:, **args) ⇒ Paperdrive::Response

GET

List files attached to a person

Parameters:

  • id: (integer)

Returns:

See Also:



78
79
80
81
82
83
 
# File 'lib/paperdrive/client/persons.rb', line 78

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

#person_followers(id:, **args) ⇒ Paperdrive::Response

GET

List followers of a person

Parameters:

  • id: (integer)

Returns:

See Also:



102
103
104
105
106
107
 
# File 'lib/paperdrive/client/persons.rb', line 102

def person_followers(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "persons/#{id}/followers", params)
end

#person_mail_messages(id:, **args) ⇒ Paperdrive::Response

GET

List mail messages associated with a person

Parameters:

  • id: (integer)

Returns:

See Also:



114
115
116
117
118
119
 
# File 'lib/paperdrive/client/persons.rb', line 114

def person_mail_messages(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit
  end
  request(:get, "persons/#{id}/mailMessages", params)
end

#person_permitted_users(id:, **args) ⇒ Paperdrive::Response

GET

List permitted users

Parameters:

  • id: (integer)

Returns:

See Also:



126
127
128
129
130
131
 
# File 'lib/paperdrive/client/persons.rb', line 126

def person_permitted_users(id:, **args)
  params = parameters(args) do
    optional_params :access_level
  end
  request(:get, "persons/#{id}/permittedUsers", params)
end

#person_products(id:, **args) ⇒ Paperdrive::Response

GET

List products associated with a person

Parameters:

  • id: (integer)

Returns:

See Also:



138
139
140
141
142
143
 
# File 'lib/paperdrive/client/persons.rb', line 138

def person_products(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit
  end
  request(:get, "persons/#{id}/products", params)
end

#person_updates(id:, **args) ⇒ Paperdrive::Response

GET

List updates about a person

Parameters:

  • id: (integer)

Returns:

See Also:



90
91
92
93
94
95
 
# File 'lib/paperdrive/client/persons.rb', line 90

def person_updates(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit
  end
  request(:get, "persons/#{id}/flow", params)
end

#update_person(id:, **args) ⇒ Paperdrive::Response

PUT

Update a person

Parameters:

  • id: (integer)

Returns:

See Also:



188
189
190
191
192
193
 
# File 'lib/paperdrive/client/persons.rb', line 188

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