module Paperdrive::Client::DealFields

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

@see developers.pipedrive.com/docs/api/v1/#!/DealFields

Public Instance Methods

all_deal_fields(**args) click to toggle source
GET

Get all deal fields

@see developers.pipedrive.com/docs/api/v1/#!/DealFields/get_dealFields @return [Paperdrive::Response]

# File lib/paperdrive/client/deal_fields.rb, line 18
def all_deal_fields(**args)
  params = parameters(args) do
    optional_params :start, :limit
  end
  request(:get, 'dealFields', params)
end
create_deal_field(**args) click to toggle source
POST

Add a new deal field

@see developers.pipedrive.com/docs/api/v1/#!/DealFields/post_dealFields @return [Paperdrive::Response]

# File lib/paperdrive/client/deal_fields.rb, line 41
def create_deal_field(**args)
  params = parameters(args) do
    required_params :name, :field_type
    optional_params :name, :field_type, :options
  end
  request(:post, 'dealFields', params)
end
deal_field(id:, **args) click to toggle source
GET

Get one deal field

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/DealFields/get_dealFields_id @return [Paperdrive::Response]

# File lib/paperdrive/client/deal_fields.rb, line 30
def deal_field(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "dealFields/#{id}", params)
end
delete_deal_field(id:, **args) click to toggle source
DELETE

Delete a deal field

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/DealFields/delete_dealFields_id @return [Paperdrive::Response]

# File lib/paperdrive/client/deal_fields.rb, line 79
def delete_deal_field(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "dealFields/#{id}", params)
end
delete_deal_fields(**args) click to toggle source
DELETE

Delete multiple deal fields in bulk

@see developers.pipedrive.com/docs/api/v1/#!/DealFields/delete_dealFields @return [Paperdrive::Response]

# File lib/paperdrive/client/deal_fields.rb, line 66
def delete_deal_fields(**args)
  params = parameters(args) do
    required_params :ids
    optional_params :ids
  end
  request(:delete, 'dealFields', params)
end
update_deal_field(id:, **args) click to toggle source
PUT

Update a deal field

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/DealFields/put_dealFields_id @return [Paperdrive::Response]

# File lib/paperdrive/client/deal_fields.rb, line 54
def update_deal_field(id:, **args)
  params = parameters(args) do
    required_params :name
    optional_params :name, :options
  end
  request(:put, "dealFields/#{id}", params)
end