Module: Paperdrive::Client::Filters

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

Overview

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

See Also:

Instance Method Summary collapse

Instance Method Details

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

GET

Get all filters

Returns:

See Also:



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

def all_filters(**args)
  params = parameters(args) do
    optional_params :type
  end
  request(:get, 'filters', params)
end

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

POST

Add a new filter

Returns:

See Also:



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

def create_filter(**args)
  params = parameters(args) do
    required_params :name, :conditions, :type
    optional_params :name, :conditions, :type
  end
  request(:post, 'filters', params)
end

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

DELETE

Delete a filter

Parameters:

  • id: (integer)

Returns:

See Also:



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

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

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

DELETE

Delete multiple filters in bulk

Returns:

See Also:



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

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

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

GET

Get one filter

Parameters:

  • id: (integer)

Returns:

See Also:



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

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

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

PUT

Update filter

Parameters:

  • id: (integer)

Returns:

See Also:



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

def update_filter(id:, **args)
  params = parameters(args) do
    required_params :conditions
    optional_params :name, :conditions
  end
  request(:put, "filters/#{id}", params)
end