module Paperdrive::Client::Filters
Instance methods related to Filters
to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.
Public Instance Methods
- GET
-
Get all filters
@see developers.pipedrive.com/docs/api/v1/#!/Filters/get_filters @return [Paperdrive::Response]
# 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
- POST
-
Add a new filter
@see developers.pipedrive.com/docs/api/v1/#!/Filters/post_filters @return [Paperdrive::Response]
# 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
-
Delete a filter
@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Filters/delete_filters_id @return [Paperdrive::Response]
# 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
-
Delete multiple filters in bulk
@see developers.pipedrive.com/docs/api/v1/#!/Filters/delete_filters @return [Paperdrive::Response]
# 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
- GET
-
Get one filter
@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Filters/get_filters_id @return [Paperdrive::Response]
# 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
- PUT
-
Update filter
@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Filters/put_filters_id @return [Paperdrive::Response]
# 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