module Paperdrive::Client::Pipelines

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

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

Public Instance Methods

all_pipelines(**args) click to toggle source
GET

Get all pipelines

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

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

Add a new pipeline

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

# File lib/paperdrive/client/pipelines.rb, line 79
def create_pipeline(**args)
  params = parameters(args) do
    optional_params :name, :deal_probability, :order_nr, :active
  end
  request(:post, 'pipelines', params)
end
delete_pipeline(id:, **args) click to toggle source
DELETE

Delete a pipeline

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

# File lib/paperdrive/client/pipelines.rb, line 103
def delete_pipeline(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "pipelines/#{id}", params)
end
pipeline(id:, **args) click to toggle source
GET

Get one pipeline

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

# File lib/paperdrive/client/pipelines.rb, line 30
def pipeline(id:, **args)
  params = parameters(args) do
    optional_params :totals_convert_currency
  end
  request(:get, "pipelines/#{id}", params)
end
pipeline_deals(id:, **args) click to toggle source
GET

Get deals in a pipeline

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

# File lib/paperdrive/client/pipelines.rb, line 55
def pipeline_deals(id:, **args)
  params = parameters(args) do
    optional_params :filter_id, :user_id, :everyone, :stage_id, :start, :limit, :get_summary, :totals_convert_currency
  end
  request(:get, "pipelines/#{id}/deals", params)
end
pipeline_deals_cvr(id:, **args) click to toggle source
GET

Get deals conversion rates in pipeline

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

# File lib/paperdrive/client/pipelines.rb, line 42
def pipeline_deals_cvr(id:, **args)
  params = parameters(args) do
    required_params :start_date, :end_date
    optional_params :start_date, :end_date, :user_id
  end
  request(:get, "pipelines/#{id}/conversion_statistics", params)
end
pipeline_deals_movements(id:, **args) click to toggle source
GET

Get deals movements in pipeline

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

# File lib/paperdrive/client/pipelines.rb, line 67
def pipeline_deals_movements(id:, **args)
  params = parameters(args) do
    required_params :start_date, :end_date
    optional_params :start_date, :end_date, :user_id
  end
  request(:get, "pipelines/#{id}/movement_statistics", params)
end
update_pipeline(id:, **args) click to toggle source
PUT

Edit a pipeline

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

# File lib/paperdrive/client/pipelines.rb, line 91
def update_pipeline(id:, **args)
  params = parameters(args) do
    optional_params :name, :deal_probability, :order_nr, :active
  end
  request(:put, "pipelines/#{id}", params)
end