Class: Brevo::DealsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/api/deals_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DealsApi 



19
20
21
 
# File 'lib/brevo/api/deals_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/brevo/api/deals_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#crm_attributes_deals_get(opts = {}) ⇒ DealAttributes

Get deal attributes



35
36
37
38
 
# File 'lib/brevo/api/deals_api.rb', line 35

def crm_attributes_deals_get(opts = {})
  data, _status_code, _headers = crm_attributes_deals_get_with_http_info(opts)
  data
end

#crm_attributes_deals_get_with_http_info(opts = {}) ⇒ Array<(DealAttributes, Fixnum, Hash)>

Get deal attributes



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
 
# File 'lib/brevo/api/deals_api.rb', line 43

def crm_attributes_deals_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_attributes_deals_get ...'
  end
  # resource path
  local_var_path = '/crm/attributes/deals'

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DealAttributes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_attributes_deals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_attributes_post(body, opts = {}) ⇒ InlineResponse2003

Create a deal/company attribute



82
83
84
85
 
# File 'lib/brevo/api/deals_api.rb', line 82

def crm_attributes_post(body, opts = {})
  data, _status_code, _headers = crm_attributes_post_with_http_info(body, opts)
  data
end

#crm_attributes_post_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2003, Fixnum, Hash)>

Create a deal/company attribute



91
92
93
94
95
96
97
98
99
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
 
# File 'lib/brevo/api/deals_api.rb', line 91

def crm_attributes_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_attributes_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DealsApi.crm_attributes_post"
  end
  # resource path
  local_var_path = '/crm/attributes'

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2003')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_attributes_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_deals_get(opts = {}) ⇒ DealsList

Get all deals

Options Hash (opts):

  • :filters_attributes_deal_name (String) —

    Filter by attributes. If you have a filter for the owner on your end, please send it as filters and utilize the account email for the filtering.

  • :filters_linked_companies_ids (String) —

    Filter by linked companies ids

  • :filters_linked_contacts_ids (String) —

    Filter by linked companies ids

  • :modified_since (String) —

    Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

  • :created_since (String) —

    Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

  • :offset (Integer) —

    Index of the first document of the page

  • :limit (Integer) —

    Number of documents per page (default to 50)

  • :sort (String) —

    Sort the results in the ascending/descending order. Default order is descending by creation if &#x60;sort&#x60; is not passed

  • :sort_by (String) —

    The field used to sort field names.



142
143
144
145
 
# File 'lib/brevo/api/deals_api.rb', line 142

def crm_deals_get(opts = {})
  data, _status_code, _headers = crm_deals_get_with_http_info(opts)
  data
end

#crm_deals_get_with_http_info(opts = {}) ⇒ Array<(DealsList, Fixnum, Hash)>

Get all deals

Options Hash (opts):

  • :filters_attributes_deal_name (String) —

    Filter by attributes. If you have a filter for the owner on your end, please send it as filters and utilize the account email for the filtering.

  • :filters_linked_companies_ids (String) —

    Filter by linked companies ids

  • :filters_linked_contacts_ids (String) —

    Filter by linked companies ids

  • :modified_since (String) —

    Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

  • :created_since (String) —

    Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

  • :offset (Integer) —

    Index of the first document of the page

  • :limit (Integer) —

    Number of documents per page

  • :sort (String) —

    Sort the results in the ascending/descending order. Default order is descending by creation if &#x60;sort&#x60; is not passed

  • :sort_by (String) —

    The field used to sort field names.



159
160
161
162
163
164
165
166
167
168
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
 
# File 'lib/brevo/api/deals_api.rb', line 159

def crm_deals_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_get ...'
  end
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
    fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
  end
  # resource path
  local_var_path = '/crm/deals'

  # query parameters
  query_params = {}
  query_params[:'filters[attributes.deal_name]'] = opts[:'filters_attributes_deal_name'] if !opts[:'filters_attributes_deal_name'].nil?
  query_params[:'filters[linkedCompaniesIds]'] = opts[:'filters_linked_companies_ids'] if !opts[:'filters_linked_companies_ids'].nil?
  query_params[:'filters[linkedContactsIds]'] = opts[:'filters_linked_contacts_ids'] if !opts[:'filters_linked_contacts_ids'].nil?
  query_params[:'modifiedSince'] = opts[:'modified_since'] if !opts[:'modified_since'].nil?
  query_params[:'createdSince'] = opts[:'created_since'] if !opts[:'created_since'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DealsList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_deals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_deals_id_delete(id, opts = {}) ⇒ nil

Delete a deal



210
211
212
213
 
# File 'lib/brevo/api/deals_api.rb', line 210

def crm_deals_id_delete(id, opts = {})
  crm_deals_id_delete_with_http_info(id, opts)
  nil
end

#crm_deals_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a deal



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/brevo/api/deals_api.rb', line 219

def crm_deals_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_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 DealsApi.crm_deals_id_delete"
  end
  # resource path
  local_var_path = '/crm/deals/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_deals_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_deals_id_get(id, opts = {}) ⇒ Deal

Get a deal



261
262
263
264
 
# File 'lib/brevo/api/deals_api.rb', line 261

def crm_deals_id_get(id, opts = {})
  data, _status_code, _headers = crm_deals_id_get_with_http_info(id, opts)
  data
end

#crm_deals_id_get_with_http_info(id, opts = {}) ⇒ Array<(Deal, Fixnum, Hash)>

Get a deal



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/brevo/api/deals_api.rb', line 270

def crm_deals_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_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 DealsApi.crm_deals_id_get"
  end
  # resource path
  local_var_path = '/crm/deals/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Deal')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_deals_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_deals_id_patch(id, body, opts = {}) ⇒ nil

Update a deal



314
315
316
317
 
# File 'lib/brevo/api/deals_api.rb', line 314

def crm_deals_id_patch(id, body, opts = {})
  crm_deals_id_patch_with_http_info(id, body, opts)
  nil
end

#crm_deals_id_patch_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a deal



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/brevo/api/deals_api.rb', line 324

def crm_deals_id_patch_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_id_patch ...'
  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 DealsApi.crm_deals_id_patch"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DealsApi.crm_deals_id_patch"
  end
  # resource path
  local_var_path = '/crm/deals/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_deals_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_deals_import_post(file, mapping, opts = {}) ⇒ InlineResponse2004

Import deals(creation and updation) Import deals from a CSV file with mapping options.



372
373
374
375
 
# File 'lib/brevo/api/deals_api.rb', line 372

def crm_deals_import_post(file, mapping, opts = {})
  data, _status_code, _headers = crm_deals_import_post_with_http_info(file, mapping, opts)
  data
end

#crm_deals_import_post_with_http_info(file, mapping, opts = {}) ⇒ Array<(InlineResponse2004, Fixnum, Hash)>

Import deals(creation and updation) Import deals from a CSV file with mapping options.



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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/brevo/api/deals_api.rb', line 383

def crm_deals_import_post_with_http_info(file, mapping, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_import_post ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling DealsApi.crm_deals_import_post"
  end
  # verify the required parameter 'mapping' is set
  if @api_client.config.client_side_validation && mapping.nil?
    fail ArgumentError, "Missing the required parameter 'mapping' when calling DealsApi.crm_deals_import_post"
  end
  # resource path
  local_var_path = '/crm/deals/import'

  # query parameters
  query_params = {}

  # header parameters
  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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file
  form_params['mapping'] = mapping

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2004')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_deals_import_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_deals_link_unlink_id_patch(id, body, opts = {}) ⇒ nil

Link and Unlink a deal with contacts and companies



433
434
435
436
 
# File 'lib/brevo/api/deals_api.rb', line 433

def crm_deals_link_unlink_id_patch(id, body, opts = {})
  crm_deals_link_unlink_id_patch_with_http_info(id, body, opts)
  nil
end

#crm_deals_link_unlink_id_patch_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Link and Unlink a deal with contacts and companies



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/brevo/api/deals_api.rb', line 443

def crm_deals_link_unlink_id_patch_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_link_unlink_id_patch ...'
  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 DealsApi.crm_deals_link_unlink_id_patch"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DealsApi.crm_deals_link_unlink_id_patch"
  end
  # resource path
  local_var_path = '/crm/deals/link-unlink/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_deals_link_unlink_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_deals_post(body, opts = {}) ⇒ InlineResponse2011

Create a deal



489
490
491
492
 
# File 'lib/brevo/api/deals_api.rb', line 489

def crm_deals_post(body, opts = {})
  data, _status_code, _headers = crm_deals_post_with_http_info(body, opts)
  data
end

#crm_deals_post_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2011, Fixnum, Hash)>

Create a deal



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/brevo/api/deals_api.rb', line 498

def crm_deals_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_deals_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DealsApi.crm_deals_post"
  end
  # resource path
  local_var_path = '/crm/deals'

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2011')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_deals_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_pipeline_details_all_get(opts = {}) ⇒ Pipelines

Get all pipelines



540
541
542
543
 
# File 'lib/brevo/api/deals_api.rb', line 540

def crm_pipeline_details_all_get(opts = {})
  data, _status_code, _headers = crm_pipeline_details_all_get_with_http_info(opts)
  data
end

#crm_pipeline_details_all_get_with_http_info(opts = {}) ⇒ Array<(Pipelines, Fixnum, Hash)>

Get all pipelines



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/brevo/api/deals_api.rb', line 548

def crm_pipeline_details_all_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_pipeline_details_all_get ...'
  end
  # resource path
  local_var_path = '/crm/pipeline/details/all'

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Pipelines')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_pipeline_details_all_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_pipeline_details_get(opts = {}) ⇒ Pipeline

Get pipeline stages This endpoint is deprecated. Prefer /crm/pipeline/details/pipelineID instead.



587
588
589
590
 
# File 'lib/brevo/api/deals_api.rb', line 587

def crm_pipeline_details_get(opts = {})
  data, _status_code, _headers = crm_pipeline_details_get_with_http_info(opts)
  data
end

#crm_pipeline_details_get_with_http_info(opts = {}) ⇒ Array<(Pipeline, Fixnum, Hash)>

Get pipeline stages This endpoint is deprecated. Prefer /crm/pipeline/details/pipelineID instead.



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/brevo/api/deals_api.rb', line 596

def crm_pipeline_details_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_pipeline_details_get ...'
  end
  # resource path
  local_var_path = '/crm/pipeline/details'

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Pipeline')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_pipeline_details_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_pipeline_details_pipeline_id_get(pipeline_id, opts = {}) ⇒ Pipelines

Get a pipeline



635
636
637
638
 
# File 'lib/brevo/api/deals_api.rb', line 635

def crm_pipeline_details_pipeline_id_get(pipeline_id, opts = {})
  data, _status_code, _headers = crm_pipeline_details_pipeline_id_get_with_http_info(pipeline_id, opts)
  data
end

#crm_pipeline_details_pipeline_id_get_with_http_info(pipeline_id, opts = {}) ⇒ Array<(Pipelines, Fixnum, Hash)>

Get a pipeline



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/brevo/api/deals_api.rb', line 644

def crm_pipeline_details_pipeline_id_get_with_http_info(pipeline_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DealsApi.crm_pipeline_details_pipeline_id_get ...'
  end
  # verify the required parameter 'pipeline_id' is set
  if @api_client.config.client_side_validation && pipeline_id.nil?
    fail ArgumentError, "Missing the required parameter 'pipeline_id' when calling DealsApi.crm_pipeline_details_pipeline_id_get"
  end
  # resource path
  local_var_path = '/crm/pipeline/details/{pipelineID}'.sub('{' + 'pipelineID' + '}', pipeline_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Pipelines')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DealsApi#crm_pipeline_details_pipeline_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#setUserAgent(user_agent) ⇒ Object

Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#VERSION/ruby



25
26
27
28
29
30
 
# File 'lib/brevo/api/deals_api.rb', line 25

def setUserAgent(user_agent)
  @user_agent = user_agent
  if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end