Class: Amocrm::Resources::PipelineStatuses

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PipelineStatuses

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 PipelineStatuses.

Parameters:



175
176
177
 
# File 'lib/amocrm/resources/pipeline_statuses.rb', line 175

def initialize(client:)
  @client = client
end

Instance Method Details

#create(pipeline_id, body:, request_options: {}) ⇒ Amocrm::Models::PipelineStatusCreateResponse::StatusCreateResponse, Amocrm::Models::PipelineStatusCreateResponse::Problem

Create statuses.

Parameters:

Returns:

See Also:



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

def create(pipeline_id, params)
  parsed, options = Amocrm::PipelineStatusCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/v4/leads/pipelines/%1$s/statuses", pipeline_id],
    body: parsed[:body],
    model: Amocrm::Models::PipelineStatusCreateResponse,
    options: options
  )
end

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

Delete status by id.

Parameters:

Returns:

See Also:



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/amocrm/resources/pipeline_statuses.rb', line 86

def delete_by_id(id, params)
  parsed, options = Amocrm::PipelineStatusDeleteByIDParams.dump_request(params)
  pipeline_id =
    parsed.delete(:pipeline_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["api/v4/leads/pipelines/%1$s/statuses/%2$s", pipeline_id, id],
    model: Amocrm::Models::PipelineStatusDeleteByIDResponse,
    options: options
  )
end

#get_by_id(id, pipeline_id:, with: nil, request_options: {}) ⇒ Amocrm::Models::PipelineStatusGetByIDResponse::Status, Amocrm::Models::PipelineStatusGetByIDResponse::Problem

Some parameter documentations has been truncated, see Models::PipelineStatusGetByIDParams for more details.

Get status by id.

Parameters:

  • id (Integer) —

    Path param

  • pipeline_id (Integer) —

    Path param

  • with (String) —

    Query param: Expand related entities; comma-separated values (e.g. descriptions)

  • request_options (Amocrm::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/amocrm/resources/pipeline_statuses.rb', line 118

def get_by_id(id, params)
  parsed, options = Amocrm::PipelineStatusGetByIDParams.dump_request(params)
  query = Amocrm::Internal::Util.encode_query_params(parsed)
  pipeline_id =
    parsed.delete(:pipeline_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["api/v4/leads/pipelines/%1$s/statuses/%2$s", pipeline_id, id],
    query: query,
    model: Amocrm::Models::PipelineStatusGetByIDResponse,
    options: options
  )
end

#list(pipeline_id, with: nil, request_options: {}) ⇒ Amocrm::Models::PipelineStatusListResponse::StatusListResponse, Amocrm::Models::PipelineStatusListResponse::Problem

Get statuses for a pipeline.

Parameters:

  • pipeline_id (Integer)
  • with (String) —

    Expand related entities; comma-separated values (e.g. descriptions).

  • request_options (Amocrm::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/amocrm/resources/pipeline_statuses.rb', line 63

def list(pipeline_id, params = {})
  parsed, options = Amocrm::PipelineStatusListParams.dump_request(params)
  query = Amocrm::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["api/v4/leads/pipelines/%1$s/statuses", pipeline_id],
    query: query,
    model: Amocrm::Models::PipelineStatusListResponse,
    options: options
  )
end

#update(pipeline_id, body:, request_options: {}) ⇒ Amocrm::Models::PipelineStatusUpdateResponse::StatusUpdateResponse, Amocrm::Models::PipelineStatusUpdateResponse::Problem

Update statuses (batch).

Parameters:

Returns:

See Also:



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/amocrm/resources/pipeline_statuses.rb', line 39

def update(pipeline_id, params)
  parsed, options = Amocrm::PipelineStatusUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/v4/leads/pipelines/%1$s/statuses", pipeline_id],
    body: parsed[:body],
    model: Amocrm::Models::PipelineStatusUpdateResponse,
    options: options
  )
end

#update_by_id(id, pipeline_id:, color: nil, descriptions: nil, name: nil, request_id: nil, sort: nil, request_options: {}) ⇒ Amocrm::Models::PipelineStatusUpdateByIDResponse::StatusUpdateResponse, Amocrm::Models::PipelineStatusUpdateByIDResponse::Problem

Update status by id.

Parameters:

Returns:

See Also:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/amocrm/resources/pipeline_statuses.rb', line 157

def update_by_id(id, params)
  parsed, options = Amocrm::PipelineStatusUpdateByIDParams.dump_request(params)
  pipeline_id =
    parsed.delete(:pipeline_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :patch,
    path: ["api/v4/leads/pipelines/%1$s/statuses/%2$s", pipeline_id, id],
    body: parsed,
    model: Amocrm::Models::PipelineStatusUpdateByIDResponse,
    options: options
  )
end