Class: SwaggerClient::HouseholdApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ HouseholdApi

Returns a new instance of HouseholdApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_household_using_post(household, opts = {}) ⇒ Household

Create a Household Create a new household, with your firm.

Parameters:

  • household —

    household

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

    the optional parameters

Returns:

  • (Household) 


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

def create_household_using_post(household, opts = {})
  data, _status_code, _headers = create_household_using_post_with_http_info(household, opts)
  data
end

#create_household_using_post_with_http_info(household, opts = {}) ⇒ Array<(Household, Fixnum, Hash)>

Create a Household Create a new household, with your firm.

Parameters:

  • household —

    household

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

    the optional parameters

Returns:

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

    Household 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/household_api.rb', line 37

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

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

#delete_household_using_delete(household_id, opts = {}) ⇒ nil

Delete a Household Permanently delete a household

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_household_using_delete(household_id, opts = {})
  delete_household_using_delete_with_http_info(household_id, opts)
  nil
end

#delete_household_using_delete_with_http_info(household_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Household Permanently delete a household

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/nucleus_api/api/household_api.rb', line 91

def delete_household_using_delete_with_http_info(household_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HouseholdApi.delete_household_using_delete ...'
  end
  # verify the required parameter 'household_id' is set
  if @api_client.config.client_side_validation && household_id.nil?
    fail ArgumentError, "Missing the required parameter 'household_id' when calling HouseholdApi.delete_household_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/household/{household_id}'.sub('{' + 'household_id' + '}', household_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: HouseholdApi#delete_household_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_household_all_using_get(opts = {}) ⇒ PageHousehold

List all household Get details for all Household.

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:

  • (PageHousehold) 


136
137
138
139
 
# File 'lib/nucleus_api/api/household_api.rb', line 136

def get_household_all_using_get(opts = {})
  data, _status_code, _headers = get_household_all_using_get_with_http_info(opts)
  data
end

#get_household_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageHousehold, Fixnum, Hash)>

List all household Get details for all Household.

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<(PageHousehold, Fixnum, Hash)>) —

    PageHousehold data, response status code and response headers



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
181
182
183
184
185
186
187
 
# File 'lib/nucleus_api/api/household_api.rb', line 150

def get_household_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HouseholdApi.get_household_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/household'

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

#get_household_client_asset_size_using_get(household_id, opts = {}) ⇒ Array<AvailableDateDoubleVO>

List all household client asset sizes Get a list of asset sizes per date for a client’s household.

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date (default to null)

  • :exclude_subledger (BOOLEAN) —

    true or false

  • :get_latest (BOOLEAN) —

    true or false

  • :sort_type (String) —

    Quarter (Q), Monthly (M) , Annually (Y), Daily (D) –caps matter, codes in ()

  • :start_date (Date) —

    start date (default to null)

Returns:

  • (Array<AvailableDateDoubleVO>) 


199
200
201
202
 
# File 'lib/nucleus_api/api/household_api.rb', line 199

def get_household_client_asset_size_using_get(household_id, opts = {})
  data, _status_code, _headers = get_household_client_asset_size_using_get_with_http_info(household_id, opts)
  data
end

#get_household_client_asset_size_using_get_with_http_info(household_id, opts = {}) ⇒ Array<(Array<AvailableDateDoubleVO>, Fixnum, Hash)>

List all household client asset sizes Get a list of asset sizes per date for a client&#39;s household.

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :exclude_subledger (BOOLEAN) —

    true or false

  • :get_latest (BOOLEAN) —

    true or false

  • :sort_type (String) —

    Quarter (Q), Monthly (M) , Annually (Y), Daily (D) –caps matter, codes in ()

  • :start_date (Date) —

    start date

Returns:

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

    Array<AvailableDateDoubleVO> data, response status code and response headers



215
216
217
218
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
257
 
# File 'lib/nucleus_api/api/household_api.rb', line 215

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

  # query parameters
  query_params = {}
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'exclude_subledger'] = opts[:'exclude_subledger'] if !opts[:'exclude_subledger'].nil?
  query_params[:'get_latest'] = opts[:'get_latest'] if !opts[:'get_latest'].nil?
  query_params[:'sort_type'] = opts[:'sort_type'] if !opts[:'sort_type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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 => 'Array<AvailableDateDoubleVO>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HouseholdApi#get_household_client_asset_size_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_household_client_holding_using_get(household_id, opts = {}) ⇒ PagePortfolioHoldingAgg

List all household’s clientIds holdings Get the information for all the securities that are currently being held by a household’s client ids registered with your firm.

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date - yyyy-mm-dd

  • :filter (String) —

    filter

  • :get_latest (BOOLEAN) —

    true or false

  • :order_by (String) —

    order_by (default to date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (Date) —

    start date - yyyy-mm-dd

Returns:

  • (PagePortfolioHoldingAgg) 


272
273
274
275
 
# File 'lib/nucleus_api/api/household_api.rb', line 272

def get_household_client_holding_using_get(household_id, opts = {})
  data, _status_code, _headers = get_household_client_holding_using_get_with_http_info(household_id, opts)
  data
end

#get_household_client_holding_using_get_with_http_info(household_id, opts = {}) ⇒ Array<(PagePortfolioHoldingAgg, Fixnum, Hash)>

List all household&#39;s clientIds holdings Get the information for all the securities that are currently being held by a household&#39;s client ids registered with your firm.

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date - yyyy-mm-dd

  • :filter (String) —

    filter

  • :get_latest (BOOLEAN) —

    true or false

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (Date) —

    start date - yyyy-mm-dd

Returns:

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

    PagePortfolioHoldingAgg data, response status code and response headers



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
331
332
333
334
335
336
 
# File 'lib/nucleus_api/api/household_api.rb', line 291

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

  # 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[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'get_latest'] = opts[:'get_latest'] if !opts[:'get_latest'].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?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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 => 'PagePortfolioHoldingAgg')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HouseholdApi#get_household_client_holding_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_household_client_transaction_using_get(household_id, opts = {}) ⇒ PagePortfolioTransaction

List all household’s client ids transactions Get the information for all transactions under a household client ids registered with your firm.

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (Date) —

    start date

Returns:

  • (PagePortfolioTransaction) 


350
351
352
353
 
# File 'lib/nucleus_api/api/household_api.rb', line 350

def get_household_client_transaction_using_get(household_id, opts = {})
  data, _status_code, _headers = get_household_client_transaction_using_get_with_http_info(household_id, opts)
  data
end

#get_household_client_transaction_using_get_with_http_info(household_id, opts = {}) ⇒ Array<(PagePortfolioTransaction, Fixnum, Hash)>

List all household&#39;s client ids transactions Get the information for all transactions under a household client ids registered with your firm.

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (Date) —

    start date

Returns:

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

    PagePortfolioTransaction data, response status code and response headers



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
408
409
410
411
412
 
# File 'lib/nucleus_api/api/household_api.rb', line 368

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

  # 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[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].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?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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 => 'PagePortfolioTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HouseholdApi#get_household_client_transaction_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_household_using_get(household_id, opts = {}) ⇒ Household

Retrieve a Household Retrieve the information for a Household.

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Returns:

  • (Household) 


418
419
420
421
 
# File 'lib/nucleus_api/api/household_api.rb', line 418

def get_household_using_get(household_id, opts = {})
  data, _status_code, _headers = get_household_using_get_with_http_info(household_id, opts)
  data
end

#get_household_using_get_with_http_info(household_id, opts = {}) ⇒ Array<(Household, Fixnum, Hash)>

Retrieve a Household Retrieve the information for a Household.

Parameters:

  • household_id —

    UUID household_id

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

    the optional parameters

Returns:

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

    Household data, response status code and response headers



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

def get_household_using_get_with_http_info(household_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HouseholdApi.get_household_using_get ...'
  end
  # verify the required parameter 'household_id' is set
  if @api_client.config.client_side_validation && household_id.nil?
    fail ArgumentError, "Missing the required parameter 'household_id' when calling HouseholdApi.get_household_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/household/{household_id}'.sub('{' + 'household_id' + '}', household_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 => 'Household')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HouseholdApi#get_household_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_household_using_put(household, household_id, opts = {}) ⇒ Household

Update a Household Update the information for a Household.

Parameters:

  • household —

    household

  • household_id —

    UUID household_id

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

    the optional parameters

Returns:

  • (Household) 


471
472
473
474
 
# File 'lib/nucleus_api/api/household_api.rb', line 471

def update_household_using_put(household, household_id, opts = {})
  data, _status_code, _headers = update_household_using_put_with_http_info(household, household_id, opts)
  data
end

#update_household_using_put_with_http_info(household, household_id, opts = {}) ⇒ Array<(Household, Fixnum, Hash)>

Update a Household Update the information for a Household.

Parameters:

  • household —

    household

  • household_id —

    UUID household_id

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

    the optional parameters

Returns:

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

    Household data, response status code and response headers



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
524
 
# File 'lib/nucleus_api/api/household_api.rb', line 482

def update_household_using_put_with_http_info(household, household_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: HouseholdApi.update_household_using_put ...'
  end
  # verify the required parameter 'household' is set
  if @api_client.config.client_side_validation && household.nil?
    fail ArgumentError, "Missing the required parameter 'household' when calling HouseholdApi.update_household_using_put"
  end
  # verify the required parameter 'household_id' is set
  if @api_client.config.client_side_validation && household_id.nil?
    fail ArgumentError, "Missing the required parameter 'household_id' when calling HouseholdApi.update_household_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/household/{household_id}'.sub('{' + 'household_id' + '}', household_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(household)
  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 => 'Household')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: HouseholdApi#update_household_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end