module Paperdrive::Client::ProductFields

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

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

Public Instance Methods

all_product_fields(**args) click to toggle source
GET

Get all product fields

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

# File lib/paperdrive/client/product_fields.rb, line 18
def all_product_fields(**args)
  params = parameters(args) do
    optional_params
  end
  request(:get, 'productFields', params)
end
create_product_field(**args) click to toggle source
POST

Add a new product field

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

# File lib/paperdrive/client/product_fields.rb, line 41
def create_product_field(**args)
  params = parameters(args) do
    required_params :name, :field_type
    optional_params :name, :field_type, :options
  end
  request(:post, 'productFields', params)
end
delete_product_field(id:, **args) click to toggle source
DELETE

Delete a product field

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

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

Delete multiple product fields in bulk

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

# File lib/paperdrive/client/product_fields.rb, line 66
def delete_product_fields(**args)
  params = parameters(args) do
    required_params :ids
    optional_params :ids
  end
  request(:delete, 'productFields', params)
end
product_field(id:, **args) click to toggle source
GET

Get one product field

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

# File lib/paperdrive/client/product_fields.rb, line 30
def product_field(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "productFields/#{id}", params)
end
update_product_field(id:, **args) click to toggle source
PUT

Update a product field

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

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