Module: Paperdrive::Client::Activities

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

Overview

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

See Also:

Instance Method Summary collapse

Instance Method Details

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

GET

fetch a single activity

Parameters:

  • id: (integer) —

    ID of the activity to fetch

Returns:

See Also:



33
34
35
36
37
38
 
# 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

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

GET

fetch Activities list

Examples:

client.all_activities(type: 'task', start_date: '2020-05-01', done: 0)

Returns:

See Also:



21
22
23
24
25
26
 
# 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

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

POST

create a single activity

Returns:

See Also:



44
45
46
47
48
49
50
 
# 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_activities(**args) ⇒ Paperdrive::Response

DELETE

delete multiple activities

Examples:

Delete activities whose IDs are 1,2,3,4,5,6,7,8,9,10

client.delete_activities(ids: [*(1..10)])

Returns:

See Also:



70
71
72
73
74
75
76
 
# File 'lib/paperdrive/client/activities.rb', line 70

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

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

DELETE

delete a single activity

Examples:

Delete the actibity whose id = 1

client.delete_activities(id: 1)

Returns:

See Also:



84
85
86
87
88
89
 
# File 'lib/paperdrive/client/activities.rb', line 84

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

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

PUT

update a single activity

Parameters:

  • id: (integer) —

    ID of the actibity to update

Returns:

See Also:



57
58
59
60
61
62
 
# File 'lib/paperdrive/client/activities.rb', line 57

def edit_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