Module: Paperdrive::Client::ActivityTypes

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

Overview

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

See Also:

Instance Method Summary collapse

Instance Method Details

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

GET

fetch activity types list

Returns:

See Also:



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

def all_activity_types(**args)
  params = parameters(args) do
    optional_params
  end
  request(:get, 'activityTypes', params)
end

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

POST

create an activity type

Returns:

See Also:



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

def create_activity_type(**args)
  params = parameters(args) do
    required_params :name, :icon_key
    optional_params :name, :icon_key, :color
  end
  request(:post, 'activityTypes', params)
end

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

DELETE

delete multiple activity types

Examples:

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

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

Returns:

See Also:



55
56
57
58
59
60
61
 
# File 'lib/paperdrive/client/activity_types.rb', line 55

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

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

DELETE

delete an activity type

Examples:

Delete the activity type whose id = 1

client.delete_activity_types(id: 1)

Returns:

See Also:



69
70
71
72
73
74
 
# File 'lib/paperdrive/client/activity_types.rb', line 69

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

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

PUT

update an activity type

Parameters:

  • id: (integer) —

    ID of the activity type to update

Returns:

See Also:



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

def edit_activity_type(id:, **args)
  params = parameters(args) do
    optional_params :name, :icon_key, :color, :order_nr
  end
  request(:put, "activityTypes/#{id}", params)
end