Class: Amocrm::Resources::Pipelines

Inherits:
Object
  • Object
show all
Defined in:
lib/amocrm/resources/pipelines.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Pipelines

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Pipelines.

Parameters:



134
135
136
 
# File 'lib/amocrm/resources/pipelines.rb', line 134

def initialize(client:)
  @client = client
end

Instance Method Details

#create(body:, request_options: {}) ⇒ Amocrm::Models::PipelineCreateResponse::PipelineCreateResponse, Amocrm::Models::PipelineCreateResponse::Problem

Create pipelines.

Parameters:

Returns:

See Also:



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/amocrm/resources/pipelines.rb', line 16

def create(params)
  parsed, options = Amocrm::PipelineCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v4/leads/pipelines",
    body: parsed[:body],
    model: Amocrm::Models::PipelineCreateResponse,
    options: options
  )
end

#delete_by_id(id, request_options: {}) ⇒ Amocrm::Models::PipelineDeleteByIDResponse::EmptyResponse, Amocrm::Models::PipelineDeleteByIDResponse::Problem

Delete pipeline by id.

Parameters:

Returns:

See Also:



76
77
78
79
80
81
82
83
 
# File 'lib/amocrm/resources/pipelines.rb', line 76

def delete_by_id(id, params = {})
  @client.request(
    method: :delete,
    path: ["api/v4/leads/pipelines/%1$s", id],
    model: Amocrm::Models::PipelineDeleteByIDResponse,
    options: params[:request_options]
  )
end

#get_by_id(id, request_options: {}) ⇒ Amocrm::Models::PipelineGetByIDResponse::Pipeline, Amocrm::Models::PipelineGetByIDResponse::Problem

Get pipeline by id.

Parameters:

Returns:

See Also:



95
96
97
98
99
100
101
102
 
# File 'lib/amocrm/resources/pipelines.rb', line 95

def get_by_id(id, params = {})
  @client.request(
    method: :get,
    path: ["api/v4/leads/pipelines/%1$s", id],
    model: Amocrm::Models::PipelineGetByIDResponse,
    options: params[:request_options]
  )
end

#list(request_options: {}) ⇒ Amocrm::Models::PipelineListResponse::PipelineListResponse, Amocrm::Models::PipelineListResponse::Problem

Get pipelines list.

Parameters:

Returns:

See Also:



57
58
59
60
61
62
63
64
 
# File 'lib/amocrm/resources/pipelines.rb', line 57

def list(params = {})
  @client.request(
    method: :get,
    path: "api/v4/leads/pipelines",
    model: Amocrm::Models::PipelineListResponse,
    options: params[:request_options]
  )
end

#update(body:, request_options: {}) ⇒ Amocrm::Models::PipelineUpdateResponse::PipelineUpdateResponse, Amocrm::Models::PipelineUpdateResponse::Problem

Update pipelines (batch).

Parameters:

Returns:

See Also:



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/amocrm/resources/pipelines.rb', line 37

def update(params)
  parsed, options = Amocrm::PipelineUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: "api/v4/leads/pipelines",
    body: parsed[:body],
    model: Amocrm::Models::PipelineUpdateResponse,
    options: options
  )
end

#update_by_id(id, is_archive: nil, is_main: nil, is_unsorted_on: nil, name: nil, request_id: nil, sort: nil, request_options: {}) ⇒ Amocrm::Models::PipelineUpdateByIDResponse::PipelineUpdateResponse, Amocrm::Models::PipelineUpdateByIDResponse::Problem

Update pipeline by id.

Parameters:

  • id (Integer)
  • is_archive (Boolean)
  • is_main (Boolean)
  • is_unsorted_on (Boolean)
  • name (String)
  • request_id (String)
  • sort (Integer)
  • request_options (Amocrm::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/amocrm/resources/pipelines.rb', line 120

def update_by_id(id, params = {})
  parsed, options = Amocrm::PipelineUpdateByIDParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/v4/leads/pipelines/%1$s", id],
    body: parsed,
    model: Amocrm::Models::PipelineUpdateByIDResponse,
    options: options
  )
end