module Paperdrive::Client::Activities
Instance methods related to Activities
to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.
Public Instance Methods
- GET
-
fetch a single activity
@param [integer] id: ID of the activity to fetch @see developers.pipedrive.com/docs/api/v1/#!/Activities/get_activities_id @return [Paperdrive::Response]
# File lib/paperdrive/client/activities.rb, line 33 def activity_detail(id:, **args) params = parameters(args) do optional_params end request(:get, "activities/#{id}", params) end
- GET
-
fetch
Activities
list
@example
client.all_activities(type: 'task', start_date: '2020-05-01', done: 0)
@see developers.pipedrive.com/docs/api/v1/#!/Activities/get_activities @return [Paperdrive::Response]
# File lib/paperdrive/client/activities.rb, line 21 def all_activities(**args) params = parameters(args) do optional_params :user_id, :filter_id, :type, :start, :limit, :start_date, :end_date, :done end request(:get, 'activities', params) end
- POST
-
create a single activity
@see developers.pipedrive.com/docs/api/v1/#!/Activities/post_activities @return [Paperdrive::Response]
# File lib/paperdrive/client/activities.rb, line 44 def create_activity(**args) params = parameters(args) do required_params :subject, :type optional_params :subject, :type, :done, :due_date, :due_time, :duration, :user_id, :deal_id, :person_id, :participants, :org_id, :note end request(:post, 'activities', params) end
- DELETE
-
delete multiple activities
@example Delete activities whose IDs are 1,2,3,4,5,6,7,8,9,10
client.delete_activities(ids: [*(1..10)])
@see developers.pipedrive.com/docs/api/v1/#!/Activities/delete_activities @return [Paperdrive::Response]
# File lib/paperdrive/client/activities.rb, line 72 def delete_activities(**args) params = parameters(args) do required_params :ids optional_params :ids end request(:delete, 'activities', params) end
- DELETE
-
delete a single activity
@example Delete the actibity whose id = 1
client.delete_activities(id: 1)
@see developers.pipedrive.com/docs/api/v1/#!/Activities/delete_activities_id @return [Paperdrive::Response]
# File lib/paperdrive/client/activities.rb, line 86 def delete_activity(id:, **args) params = parameters(args) do optional_params end request(:delete, "activities/#{id}", params) end
- PUT
-
update a single activity
@param [integer] id: ID of the actibity to update @see developers.pipedrive.com/docs/api/v1/#!/Activities/put_activities_id @return [Paperdrive::Response]
# File lib/paperdrive/client/activities.rb, line 57 def update_activity(id:, **args) params = parameters(args) do optional_params :subject, :type, :done, :due_date, :due_time, :duration, :user_id, :deal_id, :person_id, :participants, :org_id, :note end request(:put, "activities/#{id}", params) end