Class: Brevo::CompaniesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CompaniesApi

Returns a new instance of CompaniesApi.



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

def api_client
  @api_client
end

Instance Method Details

#companies_get(opts = {}) ⇒ CompaniesList

Get all companies

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filters (String) —

    Filter by attrbutes. If you have filter for owner on your side please send it as "attributes.owner":"5b1a17d914b73d35a76ca0c7"

  • :linked_contacts_ids (Integer) —

    Filter by linked contacts ids

  • :linked_deals_ids (String) —

    Filter by linked deals 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.

  • :page (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 `sort` is not passed

  • :sort_by (String) —

    The field used to sort field names.

Returns:



44
45
46
47
 
# File 'lib/brevo/api/companies_api.rb', line 44

def companies_get(opts = {})
  data, _status_code, _headers = companies_get_with_http_info(opts)
  data
end

#companies_get_with_http_info(opts = {}) ⇒ Array<(CompaniesList, Fixnum, Hash)>

Get all companies

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filters (String) —

    Filter by attrbutes. If you have filter for owner on your side please send it as &quot;attributes.owner&quot;:&quot;5b1a17d914b73d35a76ca0c7&quot;

  • :linked_contacts_ids (Integer) —

    Filter by linked contacts ids

  • :linked_deals_ids (String) —

    Filter by linked deals 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.

  • :page (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.

Returns:

  • (Array<(CompaniesList, Fixnum, Hash)>) —

    CompaniesList data, response status code and response headers



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/brevo/api/companies_api.rb', line 61

def companies_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_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 = '/companies'

  # query parameters
  query_params = {}
  query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil?
  query_params[:'linkedContactsIds'] = opts[:'linked_contacts_ids'] if !opts[:'linked_contacts_ids'].nil?
  query_params[:'linkedDealsIds'] = opts[:'linked_deals_ids'] if !opts[:'linked_deals_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[:'page'] = opts[:'page'] if !opts[:'page'].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 => 'CompaniesList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompaniesApi#companies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a company

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


112
113
114
115
 
# File 'lib/brevo/api/companies_api.rb', line 112

def companies_id_delete(id, opts = {})
  companies_id_delete_with_http_info(id, opts)
  nil
end

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

Delete a company

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/brevo/api/companies_api.rb', line 121

def companies_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_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 CompaniesApi.companies_id_delete"
  end
  # resource path
  local_var_path = '/companies/{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: CompaniesApi#companies_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#companies_id_get(id, opts = {}) ⇒ Company

Get a company

Parameters:

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/brevo/api/companies_api.rb', line 163

def companies_id_get(id, opts = {})
  data, _status_code, _headers = companies_id_get_with_http_info(id, opts)
  data
end

#companies_id_get_with_http_info(id, opts = {}) ⇒ Array<(Company, Fixnum, Hash)>

Get a company

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Company, Fixnum, Hash)>) —

    Company data, response status code and response headers



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

def companies_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_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 CompaniesApi.companies_id_get"
  end
  # resource path
  local_var_path = '/companies/{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 => 'Company')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompaniesApi#companies_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#companies_id_patch(id, body, opts = {}) ⇒ Company

Update a company

Parameters:

  • id
  • body —

    Updated company details.

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

    the optional parameters

Returns:



216
217
218
219
 
# File 'lib/brevo/api/companies_api.rb', line 216

def companies_id_patch(id, body, opts = {})
  data, _status_code, _headers = companies_id_patch_with_http_info(id, body, opts)
  data
end

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

Update a company

Parameters:

  • id
  • body —

    Updated company details.

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

    the optional parameters

Returns:

  • (Array<(Company, Fixnum, Hash)>) —

    Company data, response status code and response headers



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
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/brevo/api/companies_api.rb', line 226

def companies_id_patch_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_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 CompaniesApi.companies_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 CompaniesApi.companies_id_patch"
  end
  # resource path
  local_var_path = '/companies/{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,
    :return_type => 'Company')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompaniesApi#companies_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

  • file —

    The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) company_id [brevo mongoID to update deals] (b) associated_contact © associated_deal (f) any other attribute with internal name

  • mapping —

    The mapping options in JSON format. json { &quot;link_entities&quot;: true, // Determines whether to link related entities during the import process &quot;unlink_entities&quot;: false, //Determines whether to unlink related entities during the import process. &quot;update_existing_records&quot;: true, // Determines whether to update based on company ID or treat every row as create &quot;unset_empty_attributes&quot;: false // Determines whether unset a specific attribute during update if values input is blank &quot;use_company_identifier&quot;: false // Determines whether to use company name as identifier }

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

    the optional parameters

Returns:



275
276
277
278
 
# File 'lib/brevo/api/companies_api.rb', line 275

def companies_import_post(file, mapping, opts = {})
  data, _status_code, _headers = companies_import_post_with_http_info(file, mapping, opts)
  data
end

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

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

Parameters:

  • file —

    The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) company_id [brevo mongoID to update deals] (b) associated_contact © associated_deal (f) any other attribute with internal name

  • mapping —

    The mapping options in JSON format. json { &quot;link_entities&quot;: true, // Determines whether to link related entities during the import process &quot;unlink_entities&quot;: false, //Determines whether to unlink related entities during the import process. &quot;update_existing_records&quot;: true, // Determines whether to update based on company ID or treat every row as create &quot;unset_empty_attributes&quot;: false // Determines whether unset a specific attribute during update if values input is blank &quot;use_company_identifier&quot;: false // Determines whether to use company name as identifier }

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

    the optional parameters

Returns:

  • (Array<(InlineResponse2004, Fixnum, Hash)>) —

    InlineResponse2004 data, response status code and response headers



286
287
288
289
290
291
292
293
294
295
296
297
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
 
# File 'lib/brevo/api/companies_api.rb', line 286

def companies_import_post_with_http_info(file, mapping, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_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 CompaniesApi.companies_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 CompaniesApi.companies_import_post"
  end
  # resource path
  local_var_path = '/companies/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: CompaniesApi#companies_import_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Link and Unlink company with contacts and deals

Parameters:

  • id
  • body —

    Linked / Unlinked contacts and deals ids.

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

    the optional parameters

Returns:

  • (nil) 


336
337
338
339
 
# File 'lib/brevo/api/companies_api.rb', line 336

def companies_link_unlink_id_patch(id, body, opts = {})
  companies_link_unlink_id_patch_with_http_info(id, body, opts)
  nil
end

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

Link and Unlink company with contacts and deals

Parameters:

  • id
  • body —

    Linked / Unlinked contacts and deals ids.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



346
347
348
349
350
351
352
353
354
355
356
357
358
359
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
 
# File 'lib/brevo/api/companies_api.rb', line 346

def companies_link_unlink_id_patch_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_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 CompaniesApi.companies_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 CompaniesApi.companies_link_unlink_id_patch"
  end
  # resource path
  local_var_path = '/companies/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: CompaniesApi#companies_link_unlink_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#companies_post(body, opts = {}) ⇒ InlineResponse2002

Create a company

Parameters:

  • body —

    Company create data.

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

    the optional parameters

Returns:



392
393
394
395
 
# File 'lib/brevo/api/companies_api.rb', line 392

def companies_post(body, opts = {})
  data, _status_code, _headers = companies_post_with_http_info(body, opts)
  data
end

#companies_post_with_http_info(body, opts = {}) ⇒ Array<(InlineResponse2002, Fixnum, Hash)>

Create a company

Parameters:

  • body —

    Company create data.

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

    the optional parameters

Returns:

  • (Array<(InlineResponse2002, Fixnum, Hash)>) —

    InlineResponse2002 data, response status code and response headers



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
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/brevo/api/companies_api.rb', line 401

def companies_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.companies_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 CompaniesApi.companies_post"
  end
  # resource path
  local_var_path = '/companies'

  # 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 => 'InlineResponse2002')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompaniesApi#companies_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_attributes_companies_get(opts = {}) ⇒ CompanyAttributes

Get company attributes

Parameters:

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

    the optional parameters

Returns:



443
444
445
446
 
# File 'lib/brevo/api/companies_api.rb', line 443

def crm_attributes_companies_get(opts = {})
  data, _status_code, _headers = crm_attributes_companies_get_with_http_info(opts)
  data
end

#crm_attributes_companies_get_with_http_info(opts = {}) ⇒ Array<(CompanyAttributes, Fixnum, Hash)>

Get company attributes

Parameters:

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

    the optional parameters

Returns:

  • (Array<(CompanyAttributes, Fixnum, Hash)>) —

    CompanyAttributes data, response status code and response headers



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
485
 
# File 'lib/brevo/api/companies_api.rb', line 451

def crm_attributes_companies_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.crm_attributes_companies_get ...'
  end
  # resource path
  local_var_path = '/crm/attributes/companies'

  # 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 => 'CompanyAttributes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompaniesApi#crm_attributes_companies_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

Parameters:

  • body —

    Attribute creation data for company

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

    the optional parameters

Returns:



490
491
492
493
 
# File 'lib/brevo/api/companies_api.rb', line 490

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

Parameters:

  • body —

    Attribute creation data for company

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

    the optional parameters

Returns:

  • (Array<(InlineResponse2003, Fixnum, Hash)>) —

    InlineResponse2003 data, response status code and response headers



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
537
 
# File 'lib/brevo/api/companies_api.rb', line 499

def crm_attributes_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompaniesApi.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 CompaniesApi.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: CompaniesApi#crm_attributes_post\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/companies_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