module Paperdrive::Client::Stages

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

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

Public Instance Methods

all_stages(**args) click to toggle source
GET

Get all stages

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

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

Add a new stage

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

# File lib/paperdrive/client/stages.rb, line 53
def create_stage(**args)
  params = parameters(args) do
    required_params :name, :pipeline_id
    optional_params :name, :pipeline_id, :deal_probability, :rotten_flag, :rotten_days
  end
  request(:post, 'stages', params)
end
delete_stage(id:, **args) click to toggle source
DELETE

Delete a stage

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

# File lib/paperdrive/client/stages.rb, line 90
def delete_stage(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:delete, "stages/#{id}", params)
end
delete_stages(**args) click to toggle source
DELETE

Delete multiple stages in bulk

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

# File lib/paperdrive/client/stages.rb, line 77
def delete_stages(**args)
  params = parameters(args) do
    required_params :ids
    optional_params :ids
  end
  request(:delete, 'stages', params)
end
stage(id:, **args) click to toggle source
GET

Get one stage

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

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

Get deals in a stage

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

# File lib/paperdrive/client/stages.rb, line 42
def stage_deals(id:, **args)
  params = parameters(args) do
    optional_params :filter_id, :user_id, :everyone, :start, :limit
  end
  request(:get, "stages/#{id}/deals", params)
end
update_stage(id:, **args) click to toggle source
PUT

Update stage details

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

# File lib/paperdrive/client/stages.rb, line 66
def update_stage(id:, **args)
  params = parameters(args) do
    optional_params :name, :pipeline_id, :order_nr, :deal_probability, :rotten_flag, :rotten_days
  end
  request(:put, "stages/#{id}", params)
end