Class: Pipedrive::StagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pipedrive-openapi-client/api/stages_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StagesApi

Returns a new instance of StagesApi.



19
20
21
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#stages_delete(ids, opts = {}) ⇒ InlineResponse20010

Delete multiple stages in bulk Marks multiple stages as deleted.

Parameters:

  • ids (String) —

    Comma-separated stage IDs to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 27

def stages_delete(ids, opts = {})
  data, _status_code, _headers = stages_delete_with_http_info(ids, opts)
  data
end

#stages_delete_with_http_info(ids, opts = {}) ⇒ Array<(InlineResponse20010, Integer, Hash)>

Delete multiple stages in bulk Marks multiple stages as deleted.

Parameters:

  • ids (String) —

    Comma-separated stage IDs to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20010, Integer, Hash)>) —

    InlineResponse20010 data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 37

def stages_delete_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StagesApi.stages_delete ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling StagesApi.stages_delete"
  end
  # resource path
  local_var_path = '/stages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ids'] = ids

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20010' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StagesApi#stages_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stages_get(opts = {}) ⇒ GetStages

Get all stages Returns data about all stages.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pipeline_id (Integer) —

    The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.

Returns:



90
91
92
93
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 90

def stages_get(opts = {})
  data, _status_code, _headers = stages_get_with_http_info(opts)
  data
end

#stages_get_with_http_info(opts = {}) ⇒ Array<(GetStages, Integer, Hash)>

Get all stages Returns data about all stages.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pipeline_id (Integer) —

    The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.

Returns:

  • (Array<(GetStages, Integer, Hash)>) —

    GetStages data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 100

def stages_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StagesApi.stages_get ...'
  end
  # resource path
  local_var_path = '/stages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pipeline_id'] = opts[:'pipeline_id'] if !opts[:'pipeline_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'GetStages' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StagesApi#stages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stages_id_deals_get(id, opts = {}) ⇒ GetStageDeals

Get deals in a stage Lists deals in a specific stage.

Parameters:

  • id (Integer) —

    ID of the stage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_id (Integer) —

    If supplied, only deals matching the given filter will be returned.

  • :user_id (Integer) —

    If supplied, filter_id will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.

  • :everyone (NumberBoolean) —

    If supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned.

  • :start (Integer) —

    Pagination start (default to 0)

  • :limit (Integer) —

    Items shown per page

Returns:



154
155
156
157
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 154

def stages_id_deals_get(id, opts = {})
  data, _status_code, _headers = stages_id_deals_get_with_http_info(id, opts)
  data
end

#stages_id_deals_get_with_http_info(id, opts = {}) ⇒ Array<(GetStageDeals, Integer, Hash)>

Get deals in a stage Lists deals in a specific stage.

Parameters:

  • id (Integer) —

    ID of the stage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filter_id (Integer) —

    If supplied, only deals matching the given filter will be returned.

  • :user_id (Integer) —

    If supplied, filter_id will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.

  • :everyone (NumberBoolean) —

    If supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned.

  • :start (Integer) —

    Pagination start

  • :limit (Integer) —

    Items shown per page

Returns:

  • (Array<(GetStageDeals, Integer, Hash)>) —

    GetStageDeals data, response status code and response headers



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 169

def stages_id_deals_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StagesApi.stages_id_deals_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StagesApi.stages_id_deals_get"
  end
  # resource path
  local_var_path = '/stages/{id}/deals'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter_id'] = opts[:'filter_id'] if !opts[:'filter_id'].nil?
  query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'everyone'] = opts[:'everyone'] if !opts[:'everyone'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'GetStageDeals' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StagesApi#stages_id_deals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stages_id_delete(id, opts = {}) ⇒ InlineResponse20011

Delete a stage Marks a stage as deleted.

Parameters:

  • id (Integer) —

    ID of the stage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



226
227
228
229
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 226

def stages_id_delete(id, opts = {})
  data, _status_code, _headers = stages_id_delete_with_http_info(id, opts)
  data
end

#stages_id_delete_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse20011, Integer, Hash)>

Delete a stage Marks a stage as deleted.

Parameters:

  • id (Integer) —

    ID of the stage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20011, Integer, Hash)>) —

    InlineResponse20011 data, response status code and response headers



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 236

def stages_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StagesApi.stages_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StagesApi.stages_id_delete"
  end
  # resource path
  local_var_path = '/stages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'InlineResponse20011' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StagesApi#stages_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stages_id_get(id, opts = {}) ⇒ GetOneStage

Get one stage Returns data about a specific stage.

Parameters:

  • id (Integer) —

    ID of the stage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



288
289
290
291
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 288

def stages_id_get(id, opts = {})
  data, _status_code, _headers = stages_id_get_with_http_info(id, opts)
  data
end

#stages_id_get_with_http_info(id, opts = {}) ⇒ Array<(GetOneStage, Integer, Hash)>

Get one stage Returns data about a specific stage.

Parameters:

  • id (Integer) —

    ID of the stage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetOneStage, Integer, Hash)>) —

    GetOneStage data, response status code and response headers



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 298

def stages_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StagesApi.stages_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StagesApi.stages_id_get"
  end
  # resource path
  local_var_path = '/stages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'GetOneStage' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StagesApi#stages_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stages_id_put(id, opts = {}) ⇒ GetAddUpdateStage

Update stage details Updates the properties of a stage.

Parameters:

  • id (Integer) —

    ID of the stage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



350
351
352
353
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 350

def stages_id_put(id, opts = {})
  data, _status_code, _headers = stages_id_put_with_http_info(id, opts)
  data
end

#stages_id_put_with_http_info(id, opts = {}) ⇒ Array<(GetAddUpdateStage, Integer, Hash)>

Update stage details Updates the properties of a stage.

Parameters:

  • id (Integer) —

    ID of the stage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetAddUpdateStage, Integer, Hash)>) —

    GetAddUpdateStage data, response status code and response headers



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 360

def stages_id_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StagesApi.stages_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StagesApi.stages_id_put"
  end
  # resource path
  local_var_path = '/stages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'GetAddUpdateStage' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StagesApi#stages_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stages_post(opts = {}) ⇒ GetAddUpdateStage

Add a new stage Adds a new stage, returns the ID upon success.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



413
414
415
416
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 413

def stages_post(opts = {})
  data, _status_code, _headers = stages_post_with_http_info(opts)
  data
end

#stages_post_with_http_info(opts = {}) ⇒ Array<(GetAddUpdateStage, Integer, Hash)>

Add a new stage Adds a new stage, returns the ID upon success.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetAddUpdateStage, Integer, Hash)>) —

    GetAddUpdateStage data, response status code and response headers



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/pipedrive-openapi-client/api/stages_api.rb', line 422

def stages_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StagesApi.stages_post ...'
  end
  # resource path
  local_var_path = '/stages'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'GetAddUpdateStage' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StagesApi#stages_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end