Module: Paperdrive::Client::DealFields

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

Overview

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

See Also:

Instance Method Summary collapse

Instance Method Details

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

GET

Get all deal fields

Returns:

See Also:



18
19
20
21
22
23
 
# 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) ⇒ Paperdrive::Response

POST

Add a new deal field

Returns:

See Also:



41
42
43
44
45
46
47
 
# 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) ⇒ Paperdrive::Response

GET

Get one deal field

Parameters:

  • id: (integer)

Returns:

See Also:



30
31
32
33
34
35
 
# 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) ⇒ Paperdrive::Response

DELETE

Delete a deal field

Parameters:

  • id: (integer)

Returns:

See Also:



79
80
81
82
83
84
 
# 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) ⇒ Paperdrive::Response

DELETE

Delete multiple deal fields in bulk

Returns:

See Also:



66
67
68
69
70
71
72
 
# 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) ⇒ Paperdrive::Response

PUT

Update a deal field

Parameters:

  • id: (integer)

Returns:

See Also:



54
55
56
57
58
59
60
 
# 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