Class: NucleusApi::ContactApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/contact_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactApi

Returns a new instance of ContactApi.



19
20
21
 
# File 'lib/nucleus_api/api/contact_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/nucleus_api/api/contact_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_contact_using_post(contact, opts = {}) ⇒ Contact

Create a contact Create a new contact, with your firm.

Parameters:

  • contact —

    contact

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/nucleus_api/api/contact_api.rb', line 27

def create_contact_using_post(contact, opts = {})
  data, _status_code, _headers = create_contact_using_post_with_http_info(contact, opts)
  data
end

#create_contact_using_post_with_http_info(contact, opts = {}) ⇒ Array<(Contact, Fixnum, Hash)>

Create a contact Create a new contact, with your firm.

Parameters:

  • contact —

    contact

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

    the optional parameters

Returns:

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

    Contact 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
 
# File 'lib/nucleus_api/api/contact_api.rb', line 37

def create_contact_using_post_with_http_info(contact, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.create_contact_using_post ...'
  end
  # verify the required parameter 'contact' is set
  if @api_client.config.client_side_validation && contact.nil?
    fail ArgumentError, "Missing the required parameter 'contact' when calling ContactApi.create_contact_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/contact'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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(contact)
  auth_names = ['oauth2']
  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 => 'Contact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#create_contact_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_customer_revenue_using_post(customer_revenue, opts = {}) ⇒ CustomerRevenue

Create a customer revenue Create a new customer revenue, with your firm.

Parameters:

  • customer_revenue —

    customerRevenue

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/nucleus_api/api/contact_api.rb', line 81

def create_customer_revenue_using_post(customer_revenue, opts = {})
  data, _status_code, _headers = create_customer_revenue_using_post_with_http_info(customer_revenue, opts)
  data
end

#create_customer_revenue_using_post_with_http_info(customer_revenue, opts = {}) ⇒ Array<(CustomerRevenue, Fixnum, Hash)>

Create a customer revenue Create a new customer revenue, with your firm.

Parameters:

  • customer_revenue —

    customerRevenue

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

    the optional parameters

Returns:

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

    CustomerRevenue data, response status code and response headers



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/nucleus_api/api/contact_api.rb', line 91

def create_customer_revenue_using_post_with_http_info(customer_revenue, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.create_customer_revenue_using_post ...'
  end
  # verify the required parameter 'customer_revenue' is set
  if @api_client.config.client_side_validation && customer_revenue.nil?
    fail ArgumentError, "Missing the required parameter 'customer_revenue' when calling ContactApi.create_customer_revenue_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/customer_revenue'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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(customer_revenue)
  auth_names = ['oauth2']
  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 => 'CustomerRevenue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#create_customer_revenue_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contact_using_delete(contact_id, opts = {}) ⇒ nil

Delete a contact Delete a contact.

Parameters:

  • contact_id —

    UUID contact_id

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

    the optional parameters

Returns:

  • (nil) 


135
136
137
138
 
# File 'lib/nucleus_api/api/contact_api.rb', line 135

def delete_contact_using_delete(contact_id, opts = {})
  delete_contact_using_delete_with_http_info(contact_id, opts)
  nil
end

#delete_contact_using_delete_with_http_info(contact_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a contact Delete a contact.

Parameters:

  • contact_id —

    UUID contact_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/nucleus_api/api/contact_api.rb', line 145

def delete_contact_using_delete_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.delete_contact_using_delete ...'
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.delete_contact_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/contact/{contact_id}'.sub('{' + 'contact_id' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: ContactApi#delete_contact_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_customer_revenue_using_delete(customer_revenue_id, opts = {}) ⇒ nil

Delete a customer revenue Delete a customer revenue.

Parameters:

  • customer_revenue_id —

    UUID customer_revenue_id

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

    the optional parameters

Returns:

  • (nil) 


186
187
188
189
 
# File 'lib/nucleus_api/api/contact_api.rb', line 186

def delete_customer_revenue_using_delete(customer_revenue_id, opts = {})
  delete_customer_revenue_using_delete_with_http_info(customer_revenue_id, opts)
  nil
end

#delete_customer_revenue_using_delete_with_http_info(customer_revenue_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a customer revenue Delete a customer revenue.

Parameters:

  • customer_revenue_id —

    UUID customer_revenue_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/nucleus_api/api/contact_api.rb', line 196

def delete_customer_revenue_using_delete_with_http_info(customer_revenue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.delete_customer_revenue_using_delete ...'
  end
  # verify the required parameter 'customer_revenue_id' is set
  if @api_client.config.client_side_validation && customer_revenue_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_revenue_id' when calling ContactApi.delete_customer_revenue_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/customer_revenue/{customer_revenue_id}'.sub('{' + 'customer_revenue_id' + '}', customer_revenue_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: ContactApi#delete_customer_revenue_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_all_using_get(opts = {}) ⇒ PageContact

List all contact List all contact.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



241
242
243
244
 
# File 'lib/nucleus_api/api/contact_api.rb', line 241

def get_contact_all_using_get(opts = {})
  data, _status_code, _headers = get_contact_all_using_get_with_http_info(opts)
  data
end

#get_contact_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageContact, Fixnum, Hash)>

List all contact List all contact.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageContact data, response status code and response headers



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
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/nucleus_api/api/contact_api.rb', line 255

def get_contact_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.get_contact_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/contact'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#get_contact_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contact_using_get(contact_id, opts = {}) ⇒ Contact

Retrieve a contact Retrieve a contact.

Parameters:

  • contact_id —

    UUID contact_id

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

    the optional parameters

Returns:



298
299
300
301
 
# File 'lib/nucleus_api/api/contact_api.rb', line 298

def get_contact_using_get(contact_id, opts = {})
  data, _status_code, _headers = get_contact_using_get_with_http_info(contact_id, opts)
  data
end

#get_contact_using_get_with_http_info(contact_id, opts = {}) ⇒ Array<(Contact, Fixnum, Hash)>

Retrieve a contact Retrieve a contact.

Parameters:

  • contact_id —

    UUID contact_id

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



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
344
 
# File 'lib/nucleus_api/api/contact_api.rb', line 308

def get_contact_using_get_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.get_contact_using_get ...'
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.get_contact_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/contact/{contact_id}'.sub('{' + 'contact_id' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'Contact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#get_contact_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_revenue_all_using_get(opts = {}) ⇒ PageCustomerRevenue

List all customer revenue List all customer revenue.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



355
356
357
358
 
# File 'lib/nucleus_api/api/contact_api.rb', line 355

def get_customer_revenue_all_using_get(opts = {})
  data, _status_code, _headers = get_customer_revenue_all_using_get_with_http_info(opts)
  data
end

#get_customer_revenue_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageCustomerRevenue, Fixnum, Hash)>

List all customer revenue List all customer revenue.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageCustomerRevenue data, response status code and response headers



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
408
 
# File 'lib/nucleus_api/api/contact_api.rb', line 370

def get_customer_revenue_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.get_customer_revenue_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/customer_revenue'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageCustomerRevenue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#get_customer_revenue_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer_revenue_using_get(customer_revenue_id, opts = {}) ⇒ CustomerRevenue

Retrieve a customer revenue Retrieve a customer revenue.

Parameters:

  • customer_revenue_id —

    UUID customer_revenue_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:



415
416
417
418
 
# File 'lib/nucleus_api/api/contact_api.rb', line 415

def get_customer_revenue_using_get(customer_revenue_id, opts = {})
  data, _status_code, _headers = get_customer_revenue_using_get_with_http_info(customer_revenue_id, opts)
  data
end

#get_customer_revenue_using_get_with_http_info(customer_revenue_id, opts = {}) ⇒ Array<(CustomerRevenue, Fixnum, Hash)>

Retrieve a customer revenue Retrieve a customer revenue.

Parameters:

  • customer_revenue_id —

    UUID customer_revenue_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:

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

    CustomerRevenue data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/contact_api.rb', line 426

def get_customer_revenue_using_get_with_http_info(customer_revenue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.get_customer_revenue_using_get ...'
  end
  # verify the required parameter 'customer_revenue_id' is set
  if @api_client.config.client_side_validation && customer_revenue_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_revenue_id' when calling ContactApi.get_customer_revenue_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/customer_revenue/{customer_revenue_id}'.sub('{' + 'customer_revenue_id' + '}', customer_revenue_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'CustomerRevenue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#get_customer_revenue_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_contact_using_put(contact, contact_id, opts = {}) ⇒ Contact

Update a contact Update a contact.

Parameters:

  • contact —

    contact

  • contact_id —

    UUID contact_id

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

    the optional parameters

Returns:



470
471
472
473
 
# File 'lib/nucleus_api/api/contact_api.rb', line 470

def update_contact_using_put(contact, contact_id, opts = {})
  data, _status_code, _headers = update_contact_using_put_with_http_info(contact, contact_id, opts)
  data
end

#update_contact_using_put_with_http_info(contact, contact_id, opts = {}) ⇒ Array<(Contact, Fixnum, Hash)>

Update a contact Update a contact.

Parameters:

  • contact —

    contact

  • contact_id —

    UUID contact_id

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
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
 
# File 'lib/nucleus_api/api/contact_api.rb', line 481

def update_contact_using_put_with_http_info(contact, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.update_contact_using_put ...'
  end
  # verify the required parameter 'contact' is set
  if @api_client.config.client_side_validation && contact.nil?
    fail ArgumentError, "Missing the required parameter 'contact' when calling ContactApi.update_contact_using_put"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.update_contact_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/contact/{contact_id}'.sub('{' + 'contact_id' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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(contact)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Contact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#update_contact_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_customer_revenue_using_put(customer_revenue, customer_revenue_id, opts = {}) ⇒ CustomerRevenue

Update a customer revenue Update a customer revenue.

Parameters:

  • customer_revenue —

    customer_revenue

  • customer_revenue_id —

    UUID customer_revenue_id

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

    the optional parameters

Returns:



530
531
532
533
 
# File 'lib/nucleus_api/api/contact_api.rb', line 530

def update_customer_revenue_using_put(customer_revenue, customer_revenue_id, opts = {})
  data, _status_code, _headers = update_customer_revenue_using_put_with_http_info(customer_revenue, customer_revenue_id, opts)
  data
end

#update_customer_revenue_using_put_with_http_info(customer_revenue, customer_revenue_id, opts = {}) ⇒ Array<(CustomerRevenue, Fixnum, Hash)>

Update a customer revenue Update a customer revenue.

Parameters:

  • customer_revenue —

    customer_revenue

  • customer_revenue_id —

    UUID customer_revenue_id

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

    the optional parameters

Returns:

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

    CustomerRevenue data, response status code and response headers



541
542
543
544
545
546
547
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
583
 
# File 'lib/nucleus_api/api/contact_api.rb', line 541

def update_customer_revenue_using_put_with_http_info(customer_revenue, customer_revenue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.update_customer_revenue_using_put ...'
  end
  # verify the required parameter 'customer_revenue' is set
  if @api_client.config.client_side_validation && customer_revenue.nil?
    fail ArgumentError, "Missing the required parameter 'customer_revenue' when calling ContactApi.update_customer_revenue_using_put"
  end
  # verify the required parameter 'customer_revenue_id' is set
  if @api_client.config.client_side_validation && customer_revenue_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_revenue_id' when calling ContactApi.update_customer_revenue_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/customer_revenue/{customer_revenue_id}'.sub('{' + 'customer_revenue_id' + '}', customer_revenue_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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(customer_revenue)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CustomerRevenue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactApi#update_customer_revenue_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end