Class: BudgeaClient::PFMApi

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/api/pfm_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PFMApi

Returns a new instance of PFMApi.



19
20
21
 
# File 'lib/budgea_client/api/pfm_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/budgea_client/api/pfm_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#auth_confirm_new_email_post(token, opts = {}) ⇒ nil

Confirm new email address

Parameters:

  • token —

    token received by email

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/budgea_client/api/pfm_api.rb', line 27

def auth_confirm_new_email_post(token, opts = {})
  auth_confirm_new_email_post_with_http_info(token, opts)
  nil
end

#auth_confirm_new_email_post_with_http_info(token, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Confirm new email address

Parameters:

  • token —

    token received by email

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

    the optional parameters

Returns:

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

    nil, 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/budgea_client/api/pfm_api.rb', line 37

def auth_confirm_new_email_post_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.auth_confirm_new_email_post ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling PFMApi.auth_confirm_new_email_post"
  end
  # resource path
  local_var_path = '/auth/confirmNewEmail'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['token'] = token

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

#auth_confirm_post(token, application, opts = {}) ⇒ InlineResponse2001

Confirm email address

Parameters:

  • token —

    token received in email

  • application —

    application in use

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/budgea_client/api/pfm_api.rb', line 82

def auth_confirm_post(token, application, opts = {})
  data, _status_code, _headers = auth_confirm_post_with_http_info(token, application, opts)
  data
end

#auth_confirm_post_with_http_info(token, application, opts = {}) ⇒ Array<(InlineResponse2001, Fixnum, Hash)>

Confirm email address &lt;br&gt;&lt;br&gt;

Parameters:

  • token —

    token received in email

  • application —

    application in use

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

    the optional parameters

Returns:

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

    InlineResponse2001 data, response status code and response headers



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
130
131
132
133
134
135
136
137
 
# File 'lib/budgea_client/api/pfm_api.rb', line 93

def auth_confirm_post_with_http_info(token, application, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.auth_confirm_post ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling PFMApi.auth_confirm_post"
  end
  # verify the required parameter 'application' is set
  if @api_client.config.client_side_validation && application.nil?
    fail ArgumentError, "Missing the required parameter 'application' when calling PFMApi.auth_confirm_post"
  end
  # resource path
  local_var_path = '/auth/confirm'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['token'] = token
  form_params['application'] = application

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

#auth_cookie_post(username, password, application, opts = {}) ⇒ nil

Login with credentials and set as cookie

Parameters:

  • username —

    username

  • password —

    password

  • application —

    application name

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

    the optional parameters

Options Hash (opts):

  • :scope (String) —

    scope requested for the token

Returns:

  • (nil) 


146
147
148
149
 
# File 'lib/budgea_client/api/pfm_api.rb', line 146

def auth_cookie_post(username, password, application, opts = {})
  auth_cookie_post_with_http_info(username, password, application, opts)
  nil
end

#auth_cookie_post_with_http_info(username, password, application, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Login with credentials and set as cookie

Parameters:

  • username —

    username

  • password —

    password

  • application —

    application name

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

    the optional parameters

Options Hash (opts):

  • :scope (String) —

    scope requested for the token

Returns:

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

    nil, response status code and response headers



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
206
207
208
 
# File 'lib/budgea_client/api/pfm_api.rb', line 159

def auth_cookie_post_with_http_info(username, password, application, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.auth_cookie_post ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling PFMApi.auth_cookie_post"
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling PFMApi.auth_cookie_post"
  end
  # verify the required parameter 'application' is set
  if @api_client.config.client_side_validation && application.nil?
    fail ArgumentError, "Missing the required parameter 'application' when calling PFMApi.auth_cookie_post"
  end
  # resource path
  local_var_path = '/auth/cookie'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['username'] = username
  form_params['password'] = password
  form_params['application'] = application
  form_params['scope'] = opts[:'scope'] if !opts[:'scope'].nil?

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

#auth_register_post(email, password, application, opts = {}) ⇒ InlineResponse2004

Register to API Create a new user with his email address and password.

Parameters:

  • email —

    email address

  • password —

    password

  • application —

    application in use

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

    the optional parameters

Options Hash (opts):

  • :sponsor (String) —

    sponsor code to get advantages

  • :notification_token (String) —

    APNS or GCM token to send notifications to device

Returns:



218
219
220
221
 
# File 'lib/budgea_client/api/pfm_api.rb', line 218

def auth_register_post(email, password, application, opts = {})
  data, _status_code, _headers = auth_register_post_with_http_info(email, password, application, opts)
  data
end

#auth_register_post_with_http_info(email, password, application, opts = {}) ⇒ Array<(InlineResponse2004, Fixnum, Hash)>

Register to API Create a new user with his email address and password.&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;

Parameters:

  • email —

    email address

  • password —

    password

  • application —

    application in use

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

    the optional parameters

Options Hash (opts):

  • :sponsor (String) —

    sponsor code to get advantages

  • :notification_token (String) —

    APNS or GCM token to send notifications to device

Returns:

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

    InlineResponse2004 data, response status code and response headers



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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/budgea_client/api/pfm_api.rb', line 232

def auth_register_post_with_http_info(email, password, application, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.auth_register_post ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling PFMApi.auth_register_post"
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling PFMApi.auth_register_post"
  end
  # verify the required parameter 'application' is set
  if @api_client.config.client_side_validation && application.nil?
    fail ArgumentError, "Missing the required parameter 'application' when calling PFMApi.auth_register_post"
  end
  # resource path
  local_var_path = '/auth/register'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['email'] = email
  form_params['password'] = password
  form_params['application'] = application
  form_params['sponsor'] = opts[:'sponsor'] if !opts[:'sponsor'].nil?
  form_params['notification_token'] = opts[:'notification_token'] if !opts[:'notification_token'].nil?

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

#auth_resend_confirm_email_post(opts = {}) ⇒ nil

Resend an email to confirm email address. Sent token can be re-generated as it might be expired. Note that requesting email confirmation on already confirmed profile will raise a BadRequest.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


288
289
290
291
 
# File 'lib/budgea_client/api/pfm_api.rb', line 288

def auth_resend_confirm_email_post(opts = {})
  auth_resend_confirm_email_post_with_http_info(opts)
  nil
end

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

Resend an email to confirm email address. Sent token can be re-generated as it might be expired. Note that requesting email confirmation on already confirmed profile will raise a BadRequest.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/budgea_client/api/pfm_api.rb', line 297

def auth_resend_confirm_email_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.auth_resend_confirm_email_post ...'
  end
  # resource path
  local_var_path = '/auth/resendConfirmEmail'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#auth_token_delete(opts = {}) ⇒ nil

Remove user access This endpoint removes the token in use.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


335
336
337
338
 
# File 'lib/budgea_client/api/pfm_api.rb', line 335

def auth_token_delete(opts = {})
  auth_token_delete_with_http_info(opts)
  nil
end

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

Remove user access This endpoint removes the token in use.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



344
345
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
 
# File 'lib/budgea_client/api/pfm_api.rb', line 344

def auth_token_delete_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.auth_token_delete ...'
  end
  # resource path
  local_var_path = '/auth/token'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#auth_token_post(opts = {}) ⇒ InlineResponse2005

Login to API with credentials Request a new token by giving the client_id and client_secret

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :client_id (String)
  • :client_secret (String)
  • :grant_type (String) —

    grant type

  • :scope (String) —

    scope requested for the token

Returns:



386
387
388
389
 
# File 'lib/budgea_client/api/pfm_api.rb', line 386

def auth_token_post(opts = {})
  data, _status_code, _headers = auth_token_post_with_http_info(opts)
  data
end

#auth_token_post_with_http_info(opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

Login to API with credentials Request a new token by giving the client_id and client_secret

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :client_id (String)
  • :client_secret (String)
  • :grant_type (String) —

    grant type

  • :scope (String) —

    scope requested for the token

Returns:

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

    InlineResponse2005 data, response status code and response headers



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
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/budgea_client/api/pfm_api.rb', line 399

def auth_token_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.auth_token_post ...'
  end
  # resource path
  local_var_path = '/auth/token'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
  form_params['client_secret'] = opts[:'client_secret'] if !opts[:'client_secret'].nil?
  form_params['grant_type'] = opts[:'grant_type'] if !opts[:'grant_type'].nil?
  form_params['scope'] = opts[:'scope'] if !opts[:'scope'].nil?

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

#hash_delete(opts = {}) ⇒ nil

Delete the user’s connections deletes all connections of the user given his hash

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


442
443
444
445
 
# File 'lib/budgea_client/api/pfm_api.rb', line 442

def hash_delete(opts = {})
  hash_delete_with_http_info(opts)
  nil
end

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

Delete the user&#39;s connections deletes all connections of the user given his hash&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/budgea_client/api/pfm_api.rb', line 451

def hash_delete_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.hash_delete ...'
  end
  # resource path
  local_var_path = '/hash'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_balances_get(id_user, id_account, opts = {}) ⇒ nil

Get balances of accounts Get balance (income/outcome/balance) of enabled accounts for the given period.
By default, min_date and max_date are the current month, and period is a single month.
The period is composed with units (days, months, years) and numbers. You can give for example "1month", "15days", "1year6months", etc.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximal (inclusive) date

  • :period (String) —

    split output with the given period (default: month)

Returns:

  • (nil) 


494
495
496
497
 
# File 'lib/budgea_client/api/pfm_api.rb', line 494

def (id_user, , opts = {})
  (id_user, , opts)
  nil
end

#users_id_user_accounts_id_account_balances_get_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get balances of accounts Get balance (income/outcome/balance) of enabled accounts for the given period.&lt;br&gt;&lt;br&gt;By default, min_date and max_date are the current month, and period is a single month.&lt;br&gt;&lt;br&gt;The period is composed with units (days, months, years) and numbers. You can give for example &quot;1month&quot;, &quot;15days&quot;, &quot;1year6months&quot;, etc.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximal (inclusive) date

  • :period (String) —

    split output with the given period (default: month)

Returns:

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

    nil, response status code and response headers



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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/budgea_client/api/pfm_api.rb', line 508

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_accounts_id_account_balances_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_accounts_id_account_balances_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_accounts_id_account_balances_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/balances'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_operationsalert_get(id_user, id_account, opts = {}) ⇒ InlineResponse20028

Get a list of configurated alerts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



560
561
562
563
 
# File 'lib/budgea_client/api/pfm_api.rb', line 560

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

#users_id_user_accounts_id_account_operationsalert_get_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(InlineResponse20028, Fixnum, Hash)>

Get a list of configurated alerts &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20028 data, response status code and response headers



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/budgea_client/api/pfm_api.rb', line 572

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_accounts_id_account_operationsalert_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/operationsalert'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete(id_user, id_account, id_operationsalert, opts = {}) ⇒ UserAlert

Delete an alert on transactions or investemens

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



624
625
626
627
 
# File 'lib/budgea_client/api/pfm_api.rb', line 624

def (id_user, , id_operationsalert, opts = {})
  data, _status_code, _headers = (id_user, , id_operationsalert, opts)
  data
end

#users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete_with_http_info(id_user, id_account, id_operationsalert, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Delete an alert on transactions or investemens &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



637
638
639
640
641
642
643
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
683
684
 
# File 'lib/budgea_client/api/pfm_api.rb', line 637

def (id_user, , id_operationsalert, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete"
  end
  # verify the required parameter 'id_operationsalert' is set
  if @api_client.config.client_side_validation && id_operationsalert.nil?
    fail ArgumentError, "Missing the required parameter 'id_operationsalert' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/operationsalert/{id_operationsalert}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_operationsalert' + '}', id_operationsalert.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_operationsalert_id_operationsalert_put(id_user, id_account, id_operationsalert, opts = {}) ⇒ UserAlert

Edit an alert on transactions or investemens

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:



698
699
700
701
 
# File 'lib/budgea_client/api/pfm_api.rb', line 698

def (id_user, , id_operationsalert, opts = {})
  data, _status_code, _headers = (id_user, , id_operationsalert, opts)
  data
end

#users_id_user_accounts_id_account_operationsalert_id_operationsalert_put_with_http_info(id_user, id_account, id_operationsalert, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Edit an alert on transactions or investemens

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/budgea_client/api/pfm_api.rb', line 716

def (id_user, , id_operationsalert, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_accounts_id_account_operationsalert_id_operationsalert_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_id_operationsalert_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_id_operationsalert_put"
  end
  # verify the required parameter 'id_operationsalert' is set
  if @api_client.config.client_side_validation && id_operationsalert.nil?
    fail ArgumentError, "Missing the required parameter 'id_operationsalert' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_id_operationsalert_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/operationsalert/{id_operationsalert}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_operationsalert' + '}', id_operationsalert.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['income_max'] = opts[:'income_max'] if !opts[:'income_max'].nil?
  form_params['expense_max'] = opts[:'expense_max'] if !opts[:'expense_max'].nil?
  form_params['value_type'] = opts[:'value_type'] if !opts[:'value_type'].nil?
  form_params['date_range'] = opts[:'date_range'] if !opts[:'date_range'].nil?

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

#users_id_user_accounts_id_account_operationsalert_post(id_user, id_account, opts = {}) ⇒ UserAlert

Create an alert on transactions or investemens of a given user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:



781
782
783
784
 
# File 'lib/budgea_client/api/pfm_api.rb', line 781

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

#users_id_user_accounts_id_account_operationsalert_post_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Create an alert on transactions or investemens of a given user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/budgea_client/api/pfm_api.rb', line 798

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_accounts_id_account_operationsalert_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_accounts_id_account_operationsalert_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/operationsalert'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['income_max'] = opts[:'income_max'] if !opts[:'income_max'].nil?
  form_params['expense_max'] = opts[:'expense_max'] if !opts[:'expense_max'].nil?
  form_params['value_type'] = opts[:'value_type'] if !opts[:'value_type'].nil?
  form_params['date_range'] = opts[:'date_range'] if !opts[:'date_range'].nil?

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

#users_id_user_accountsalert_get(id_user, opts = {}) ⇒ Object

Get alert configuration of a specific account

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

  • (Object) 


852
853
854
855
 
# File 'lib/budgea_client/api/pfm_api.rb', line 852

def users_id_user_accountsalert_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_accountsalert_get_with_http_info(id_user, opts)
  data
end

#users_id_user_accountsalert_get_with_http_info(id_user, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get alert configuration of a specific account &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
 
# File 'lib/budgea_client/api/pfm_api.rb', line 862

def users_id_user_accountsalert_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_accountsalert_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_accountsalert_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accountsalert'.sub('{' + 'id_user' + '}', id_user.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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accountsalert_put(id_user, opts = {}) ⇒ Object

Update alert configuration of an account It updates the alert configuration of a specific account

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expense_max (Integer) —

    threshold from which an alert has to be sent for a high expense

  • :accounts (Integer) —

    list of accounts (id coma separated) on wich the alert has to be applied. If &#39;all&#39; is given, it is applied on all accounts. default: all

  • :income_max (Integer) —

    threshold from which an alert has to be sent for a high income

  • :balance_min2 (Integer) —

    second threshold from which an alert has to be sent for a low balance

  • :enabled (BOOLEAN) —

    if false, the alert is not taken into account

Returns:

  • (Object) 


911
912
913
914
 
# File 'lib/budgea_client/api/pfm_api.rb', line 911

def users_id_user_accountsalert_put(id_user, opts = {})
  data, _status_code, _headers = users_id_user_accountsalert_put_with_http_info(id_user, opts)
  data
end

#users_id_user_accountsalert_put_with_http_info(id_user, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update alert configuration of an account It updates the alert configuration of a specific account&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expense_max (Integer) —

    threshold from which an alert has to be sent for a high expense

  • :accounts (Integer) —

    list of accounts (id coma separated) on wich the alert has to be applied. If &#39;all&#39; is given, it is applied on all accounts. default: all

  • :income_max (Integer) —

    threshold from which an alert has to be sent for a high income

  • :balance_min2 (Integer) —

    second threshold from which an alert has to be sent for a low balance

  • :enabled (BOOLEAN) —

    if false, the alert is not taken into account

Returns:

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

    Object data, response status code and response headers



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/budgea_client/api/pfm_api.rb', line 926

def users_id_user_accountsalert_put_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_accountsalert_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_accountsalert_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accountsalert'.sub('{' + 'id_user' + '}', id_user.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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['expense_max'] = opts[:'expense_max'] if !opts[:'expense_max'].nil?
  form_params['accounts'] = opts[:'accounts'] if !opts[:'accounts'].nil?
  form_params['income_max'] = opts[:'income_max'] if !opts[:'income_max'].nil?
  form_params['balance_min2'] = opts[:'balance_min2'] if !opts[:'balance_min2'].nil?
  form_params['enabled'] = opts[:'enabled'] if !opts[:'enabled'].nil?

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

#users_id_user_balances_get(id_user, opts = {}) ⇒ nil

Get balances of accounts Get balance (income/outcome/balance) of enabled accounts for the given period.
By default, min_date and max_date are the current month, and period is a single month.
The period is composed with units (days, months, years) and numbers. You can give for example "1month", "15days", "1year6months", etc.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximal (inclusive) date

  • :period (String) —

    split output with the given period (default: month)

Returns:

  • (nil) 


978
979
980
981
 
# File 'lib/budgea_client/api/pfm_api.rb', line 978

def users_id_user_balances_get(id_user, opts = {})
  users_id_user_balances_get_with_http_info(id_user, opts)
  nil
end

#users_id_user_balances_get_with_http_info(id_user, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get balances of accounts Get balance (income/outcome/balance) of enabled accounts for the given period.&lt;br&gt;&lt;br&gt;By default, min_date and max_date are the current month, and period is a single month.&lt;br&gt;&lt;br&gt;The period is composed with units (days, months, years) and numbers. You can give for example &quot;1month&quot;, &quot;15days&quot;, &quot;1year6months&quot;, etc.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximal (inclusive) date

  • :period (String) —

    split output with the given period (default: month)

Returns:

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

    nil, response status code and response headers



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/budgea_client/api/pfm_api.rb', line 991

def users_id_user_balances_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_balances_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_balances_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/balances'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_balances_get(id_user, id_connection, id_account, opts = {}) ⇒ nil

Get balances of accounts Get balance (income/outcome/balance) of enabled accounts for the given period.
By default, min_date and max_date are the current month, and period is a single month.
The period is composed with units (days, months, years) and numbers. You can give for example "1month", "15days", "1year6months", etc.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximal (inclusive) date

  • :period (String) —

    split output with the given period (default: month)

Returns:

  • (nil) 


1042
1043
1044
1045
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1042

def (id_user, id_connection, , opts = {})
  (id_user, id_connection, , opts)
  nil
end

#users_id_user_connections_id_connection_accounts_id_account_balances_get_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get balances of accounts Get balance (income/outcome/balance) of enabled accounts for the given period.&lt;br&gt;&lt;br&gt;By default, min_date and max_date are the current month, and period is a single month.&lt;br&gt;&lt;br&gt;The period is composed with units (days, months, years) and numbers. You can give for example &quot;1month&quot;, &quot;15days&quot;, &quot;1year6months&quot;, etc.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximal (inclusive) date

  • :period (String) —

    split output with the given period (default: month)

Returns:

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

    nil, response status code and response headers



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1057

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_connections_id_connection_accounts_id_account_balances_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_balances_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_balances_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_balances_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/balances'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_operationsalert_get(id_user, id_connection, id_account, opts = {}) ⇒ InlineResponse20028

Get a list of configurated alerts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1114
1115
1116
1117
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1114

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_operationsalert_get_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(InlineResponse20028, Fixnum, Hash)>

Get a list of configurated alerts &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20028 data, response status code and response headers



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1127

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete(id_user, id_connection, id_account, id_operationsalert, opts = {}) ⇒ UserAlert

Delete an alert on transactions or investments

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_operationsalert
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1184
1185
1186
1187
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1184

def (id_user, id_connection, , id_operationsalert, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_operationsalert, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete_with_http_info(id_user, id_connection, id_account, id_operationsalert, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Delete an alert on transactions or investments &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_operationsalert
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1198

def (id_user, id_connection, , id_operationsalert, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete"
  end
  # verify the required parameter 'id_operationsalert' is set
  if @api_client.config.client_side_validation && id_operationsalert.nil?
    fail ArgumentError, "Missing the required parameter 'id_operationsalert' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert/{id_operationsalert}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_operationsalert' + '}', id_operationsalert.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put(id_user, id_connection, id_account, id_operationsalert, opts = {}) ⇒ UserAlert

Edit an alert on transactions or investments

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_operationsalert
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investments

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:



1264
1265
1266
1267
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1264

def (id_user, id_connection, , id_operationsalert, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_operationsalert, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put_with_http_info(id_user, id_connection, id_account, id_operationsalert, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Edit an alert on transactions or investments

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_operationsalert
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investments

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1283

def (id_user, id_connection, , id_operationsalert, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put"
  end
  # verify the required parameter 'id_operationsalert' is set
  if @api_client.config.client_side_validation && id_operationsalert.nil?
    fail ArgumentError, "Missing the required parameter 'id_operationsalert' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert/{id_operationsalert}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_operationsalert' + '}', id_operationsalert.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['income_max'] = opts[:'income_max'] if !opts[:'income_max'].nil?
  form_params['expense_max'] = opts[:'expense_max'] if !opts[:'expense_max'].nil?
  form_params['value_type'] = opts[:'value_type'] if !opts[:'value_type'].nil?
  form_params['date_range'] = opts[:'date_range'] if !opts[:'date_range'].nil?

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

#users_id_user_connections_id_connection_accounts_id_account_operationsalert_post(id_user, id_connection, id_account, opts = {}) ⇒ UserAlert

Create an alert on transactions or investments of a given user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:



1353
1354
1355
1356
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1353

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_operationsalert_post_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Create an alert on transactions or investments of a given user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1371

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling PFMApi.users_id_user_connections_id_connection_accounts_id_account_operationsalert_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['income_max'] = opts[:'income_max'] if !opts[:'income_max'].nil?
  form_params['expense_max'] = opts[:'expense_max'] if !opts[:'expense_max'].nil?
  form_params['value_type'] = opts[:'value_type'] if !opts[:'value_type'].nil?
  form_params['date_range'] = opts[:'date_range'] if !opts[:'date_range'].nil?

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

#users_id_user_connections_id_connection_balances_get(id_user, id_connection, opts = {}) ⇒ nil

Get balances of accounts Get balance (income/outcome/balance) of enabled accounts for the given period.
By default, min_date and max_date are the current month, and period is a single month.
The period is composed with units (days, months, years) and numbers. You can give for example "1month", "15days", "1year6months", etc.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximal (inclusive) date

  • :period (String) —

    split output with the given period (default: month)

Returns:

  • (nil) 


1433
1434
1435
1436
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1433

def users_id_user_connections_id_connection_balances_get(id_user, id_connection, opts = {})
  users_id_user_connections_id_connection_balances_get_with_http_info(id_user, id_connection, opts)
  nil
end

#users_id_user_connections_id_connection_balances_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get balances of accounts Get balance (income/outcome/balance) of enabled accounts for the given period.&lt;br&gt;&lt;br&gt;By default, min_date and max_date are the current month, and period is a single month.&lt;br&gt;&lt;br&gt;The period is composed with units (days, months, years) and numbers. You can give for example &quot;1month&quot;, &quot;15days&quot;, &quot;1year6months&quot;, etc.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximal (inclusive) date

  • :period (String) —

    split output with the given period (default: month)

Returns:

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

    nil, response status code and response headers



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1447

def users_id_user_connections_id_connection_balances_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_connections_id_connection_balances_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_connections_id_connection_balances_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling PFMApi.users_id_user_connections_id_connection_balances_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/balances'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

  # query parameters
  query_params = {}
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_devices_get(id_user, opts = {}) ⇒ InlineResponse20038

Get devices

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1498
1499
1500
1501
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1498

def users_id_user_devices_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_devices_get_with_http_info(id_user, opts)
  data
end

#users_id_user_devices_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20038, Fixnum, Hash)>

Get devices

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20038 data, response status code and response headers



1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1509

def users_id_user_devices_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_devices_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_devices_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/devices'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_devices_id_device_delete(id_user, id_device, opts = {}) ⇒ Device

Delete device.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1556
1557
1558
1559
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1556

def users_id_user_devices_id_device_delete(id_user, id_device, opts = {})
  data, _status_code, _headers = users_id_user_devices_id_device_delete_with_http_info(id_user, id_device, opts)
  data
end

#users_id_user_devices_id_device_delete_with_http_info(id_user, id_device, opts = {}) ⇒ Array<(Device, Fixnum, Hash)>

Delete device.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Device data, response status code and response headers



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1568

def users_id_user_devices_id_device_delete_with_http_info(id_user, id_device, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_devices_id_device_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_devices_id_device_delete"
  end
  # verify the required parameter 'id_device' is set
  if @api_client.config.client_side_validation && id_device.nil?
    fail ArgumentError, "Missing the required parameter 'id_device' when calling PFMApi.users_id_user_devices_id_device_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/devices/{id_device}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_device' + '}', id_device.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_devices_id_device_get(id_user, id_device, opts = {}) ⇒ Device

Get a device

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1619
1620
1621
1622
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1619

def users_id_user_devices_id_device_get(id_user, id_device, opts = {})
  data, _status_code, _headers = users_id_user_devices_id_device_get_with_http_info(id_user, id_device, opts)
  data
end

#users_id_user_devices_id_device_get_with_http_info(id_user, id_device, opts = {}) ⇒ Array<(Device, Fixnum, Hash)>

Get a device

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Device data, response status code and response headers



1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1631

def users_id_user_devices_id_device_get_with_http_info(id_user, id_device, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_devices_id_device_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_devices_id_device_get"
  end
  # verify the required parameter 'id_device' is set
  if @api_client.config.client_side_validation && id_device.nil?
    fail ArgumentError, "Missing the required parameter 'id_device' when calling PFMApi.users_id_user_devices_id_device_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/devices/{id_device}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_device' + '}', id_device.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_devices_id_device_put(id_user, id_device, notification_token, application, opts = {}) ⇒ Device

Update attributes of the device.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_device
  • notification_token —

    the GCM or APNS notification_token to use

  • application —

    the device in use

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

    the optional parameters

Options Hash (opts):

  • :notification_version (Integer) —

    version of notifications

  • :expand (String)

Returns:



1685
1686
1687
1688
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1685

def users_id_user_devices_id_device_put(id_user, id_device, notification_token, application, opts = {})
  data, _status_code, _headers = users_id_user_devices_id_device_put_with_http_info(id_user, id_device, notification_token, application, opts)
  data
end

#users_id_user_devices_id_device_put_with_http_info(id_user, id_device, notification_token, application, opts = {}) ⇒ Array<(Device, Fixnum, Hash)>

Update attributes of the device.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_device
  • notification_token —

    the GCM or APNS notification_token to use

  • application —

    the device in use

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

    the optional parameters

Options Hash (opts):

  • :notification_version (Integer) —

    version of notifications

  • :expand (String)

Returns:

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

    Device data, response status code and response headers



1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1700

def users_id_user_devices_id_device_put_with_http_info(id_user, id_device, notification_token, application, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_devices_id_device_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_devices_id_device_put"
  end
  # verify the required parameter 'id_device' is set
  if @api_client.config.client_side_validation && id_device.nil?
    fail ArgumentError, "Missing the required parameter 'id_device' when calling PFMApi.users_id_user_devices_id_device_put"
  end
  # verify the required parameter 'notification_token' is set
  if @api_client.config.client_side_validation && notification_token.nil?
    fail ArgumentError, "Missing the required parameter 'notification_token' when calling PFMApi.users_id_user_devices_id_device_put"
  end
  # verify the required parameter 'application' is set
  if @api_client.config.client_side_validation && application.nil?
    fail ArgumentError, "Missing the required parameter 'application' when calling PFMApi.users_id_user_devices_id_device_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/devices/{id_device}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_device' + '}', id_device.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['notification_token'] = notification_token
  form_params['application'] = application
  form_params['notification_version'] = opts[:'notification_version'] if !opts[:'notification_version'].nil?

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

#users_id_user_devices_post(id_user, notification_token, application, opts = {}) ⇒ Device

Create a device linked to specified token.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • notification_token —

    the GCM or APNS notification_token to use

  • application —

    the device in use

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

    the optional parameters

Options Hash (opts):

  • :notification_version (Integer) —

    version of notifications

  • :expand (String)

Returns:



1764
1765
1766
1767
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1764

def users_id_user_devices_post(id_user, notification_token, application, opts = {})
  data, _status_code, _headers = users_id_user_devices_post_with_http_info(id_user, notification_token, application, opts)
  data
end

#users_id_user_devices_post_with_http_info(id_user, notification_token, application, opts = {}) ⇒ Array<(Device, Fixnum, Hash)>

Create a device linked to specified token.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • notification_token —

    the GCM or APNS notification_token to use

  • application —

    the device in use

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

    the optional parameters

Options Hash (opts):

  • :notification_version (Integer) —

    version of notifications

  • :expand (String)

Returns:

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

    Device data, response status code and response headers



1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1778

def users_id_user_devices_post_with_http_info(id_user, notification_token, application, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_devices_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_devices_post"
  end
  # verify the required parameter 'notification_token' is set
  if @api_client.config.client_side_validation && notification_token.nil?
    fail ArgumentError, "Missing the required parameter 'notification_token' when calling PFMApi.users_id_user_devices_post"
  end
  # verify the required parameter 'application' is set
  if @api_client.config.client_side_validation && application.nil?
    fail ArgumentError, "Missing the required parameter 'application' when calling PFMApi.users_id_user_devices_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/devices'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['notification_token'] = notification_token
  form_params['application'] = application
  form_params['notification_version'] = opts[:'notification_version'] if !opts[:'notification_version'].nil?

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

#users_id_user_forecast_get(id_user, opts = {}) ⇒ nil

Get forecast

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

  • (nil) 


1834
1835
1836
1837
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1834

def users_id_user_forecast_get(id_user, opts = {})
  users_id_user_forecast_get_with_http_info(id_user, opts)
  nil
end

#users_id_user_forecast_get_with_http_info(id_user, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get forecast

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1844

def users_id_user_forecast_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_forecast_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_forecast_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/forecast'.sub('{' + 'id_user' + '}', id_user.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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_get(id_user, opts = {}) ⇒ User

Get a user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1888
1889
1890
1891
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1888

def users_id_user_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_get_with_http_info(id_user, opts)
  data
end

#users_id_user_get_with_http_info(id_user, opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Get a user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    User data, response status code and response headers



1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1899

def users_id_user_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_get"
  end
  # resource path
  local_var_path = '/users/{id_user}'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_operationsalert_get(id_user, opts = {}) ⇒ InlineResponse20028

Get a list of configurated alerts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1945
1946
1947
1948
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1945

def users_id_user_operationsalert_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_operationsalert_get_with_http_info(id_user, opts)
  data
end

#users_id_user_operationsalert_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20028, Fixnum, Hash)>

Get a list of configurated alerts &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20028 data, response status code and response headers



1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1956

def users_id_user_operationsalert_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_operationsalert_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_operationsalert_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/operationsalert'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_operationsalert_id_operationsalert_delete(id_user, id_operationsalert, opts = {}) ⇒ UserAlert

Delete an alert on transactions or investemens

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2003
2004
2005
2006
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2003

def users_id_user_operationsalert_id_operationsalert_delete(id_user, id_operationsalert, opts = {})
  data, _status_code, _headers = users_id_user_operationsalert_id_operationsalert_delete_with_http_info(id_user, id_operationsalert, opts)
  data
end

#users_id_user_operationsalert_id_operationsalert_delete_with_http_info(id_user, id_operationsalert, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Delete an alert on transactions or investemens &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2015

def users_id_user_operationsalert_id_operationsalert_delete_with_http_info(id_user, id_operationsalert, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_operationsalert_id_operationsalert_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_operationsalert_id_operationsalert_delete"
  end
  # verify the required parameter 'id_operationsalert' is set
  if @api_client.config.client_side_validation && id_operationsalert.nil?
    fail ArgumentError, "Missing the required parameter 'id_operationsalert' when calling PFMApi.users_id_user_operationsalert_id_operationsalert_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/operationsalert/{id_operationsalert}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_operationsalert' + '}', id_operationsalert.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_operationsalert_id_operationsalert_put(id_user, id_operationsalert, opts = {}) ⇒ UserAlert

Edit an alert on transactions or investemens

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:



2071
2072
2073
2074
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2071

def users_id_user_operationsalert_id_operationsalert_put(id_user, id_operationsalert, opts = {})
  data, _status_code, _headers = users_id_user_operationsalert_id_operationsalert_put_with_http_info(id_user, id_operationsalert, opts)
  data
end

#users_id_user_operationsalert_id_operationsalert_put_with_http_info(id_user, id_operationsalert, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Edit an alert on transactions or investemens

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2088

def users_id_user_operationsalert_id_operationsalert_put_with_http_info(id_user, id_operationsalert, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_operationsalert_id_operationsalert_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_operationsalert_id_operationsalert_put"
  end
  # verify the required parameter 'id_operationsalert' is set
  if @api_client.config.client_side_validation && id_operationsalert.nil?
    fail ArgumentError, "Missing the required parameter 'id_operationsalert' when calling PFMApi.users_id_user_operationsalert_id_operationsalert_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/operationsalert/{id_operationsalert}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_operationsalert' + '}', id_operationsalert.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['income_max'] = opts[:'income_max'] if !opts[:'income_max'].nil?
  form_params['expense_max'] = opts[:'expense_max'] if !opts[:'expense_max'].nil?
  form_params['value_type'] = opts[:'value_type'] if !opts[:'value_type'].nil?
  form_params['date_range'] = opts[:'date_range'] if !opts[:'date_range'].nil?

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

#users_id_user_operationsalert_post(id_user, opts = {}) ⇒ UserAlert

Create an alert on transactions or investemens of a given user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:



2148
2149
2150
2151
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2148

def users_id_user_operationsalert_post(id_user, opts = {})
  data, _status_code, _headers = users_id_user_operationsalert_post_with_http_info(id_user, opts)
  data
end

#users_id_user_operationsalert_post_with_http_info(id_user, opts = {}) ⇒ Array<(UserAlert, Fixnum, Hash)>

Create an alert on transactions or investemens of a given user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    parameter to choose the scope of the alert. accepted: transactions, investements

  • :income_max (Integer) —

    capital gain thresholds

  • :expense_max (Integer) —

    capital loss thresholds

  • :value_type (String) —

    whether the threshold is given in absolut value or percent. accepted: percent, flat

  • :date_range (Integer) — default: number of days —

    range on which the analysis has to be done

  • :expand (String)

Returns:

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

    UserAlert data, response status code and response headers



2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2164

def users_id_user_operationsalert_post_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_operationsalert_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_operationsalert_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/operationsalert'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['income_max'] = opts[:'income_max'] if !opts[:'income_max'].nil?
  form_params['expense_max'] = opts[:'expense_max'] if !opts[:'expense_max'].nil?
  form_params['value_type'] = opts[:'value_type'] if !opts[:'value_type'].nil?
  form_params['date_range'] = opts[:'date_range'] if !opts[:'date_range'].nil?

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

#users_id_user_profiles_get(id_user, opts = {}) ⇒ InlineResponse20039

Get profiles

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2215
2216
2217
2218
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2215

def users_id_user_profiles_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_profiles_get_with_http_info(id_user, opts)
  data
end

#users_id_user_profiles_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20039, Fixnum, Hash)>

Get profiles

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20039 data, response status code and response headers



2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2226

def users_id_user_profiles_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_profiles_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_profiles_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/profiles'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_profiles_id_profile_get(id_user, id_profile, opts = {}) ⇒ Profile

Get a profile

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2273
2274
2275
2276
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2273

def users_id_user_profiles_id_profile_get(id_user, id_profile, opts = {})
  data, _status_code, _headers = users_id_user_profiles_id_profile_get_with_http_info(id_user, id_profile, opts)
  data
end

#users_id_user_profiles_id_profile_get_with_http_info(id_user, id_profile, opts = {}) ⇒ Array<(Profile, Fixnum, Hash)>

Get a profile

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Profile data, response status code and response headers



2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2285

def users_id_user_profiles_id_profile_get_with_http_info(id_user, id_profile, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_profiles_id_profile_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_profiles_id_profile_get"
  end
  # verify the required parameter 'id_profile' is set
  if @api_client.config.client_side_validation && id_profile.nil?
    fail ArgumentError, "Missing the required parameter 'id_profile' when calling PFMApi.users_id_user_profiles_id_profile_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/profiles/{id_profile}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_profile' + '}', id_profile.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_profiles_main_get(id_user, opts = {}) ⇒ Profile

Get the main profile

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2335
2336
2337
2338
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2335

def users_id_user_profiles_main_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_profiles_main_get_with_http_info(id_user, opts)
  data
end

#users_id_user_profiles_main_get_with_http_info(id_user, opts = {}) ⇒ Array<(Profile, Fixnum, Hash)>

Get the main profile

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Profile data, response status code and response headers



2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2346

def users_id_user_profiles_main_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_profiles_main_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_profiles_main_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/profiles/main'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_profiles_me_get(id_user, opts = {}) ⇒ Profile

Get my profile

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2392
2393
2394
2395
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2392

def users_id_user_profiles_me_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_profiles_me_get_with_http_info(id_user, opts)
  data
end

#users_id_user_profiles_me_get_with_http_info(id_user, opts = {}) ⇒ Array<(Profile, Fixnum, Hash)>

Get my profile

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Profile data, response status code and response headers



2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2403

def users_id_user_profiles_me_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_profiles_me_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_profiles_me_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/profiles/me'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_profiles_me_put(id_user, opts = {}) ⇒ Profile

Change settings of the profile.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :email (String) —

    change email of profile

  • :password (String) —

    change password of profile

  • :current_password (String) —

    needed when changing the password or the email

  • :contact (String) —

    change contact information of a profile

  • :conf (String) —

    change config of a profile

  • :state (BOOLEAN) —

    state of the profile

  • :lang (String) —

    change lang of the profile

  • :expand (String)

Returns:



2456
2457
2458
2459
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2456

def users_id_user_profiles_me_put(id_user, opts = {})
  data, _status_code, _headers = users_id_user_profiles_me_put_with_http_info(id_user, opts)
  data
end

#users_id_user_profiles_me_put_with_http_info(id_user, opts = {}) ⇒ Array<(Profile, Fixnum, Hash)>

Change settings of the profile.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :email (String) —

    change email of profile

  • :password (String) —

    change password of profile

  • :current_password (String) —

    needed when changing the password or the email

  • :contact (String) —

    change contact information of a profile

  • :conf (String) —

    change config of a profile

  • :state (BOOLEAN) —

    state of the profile

  • :lang (String) —

    change lang of the profile

  • :expand (String)

Returns:

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

    Profile data, response status code and response headers



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2474

def users_id_user_profiles_me_put_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_profiles_me_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_profiles_me_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/profiles/me'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['email'] = opts[:'email'] if !opts[:'email'].nil?
  form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
  form_params['current_password'] = opts[:'current_password'] if !opts[:'current_password'].nil?
  form_params['contact'] = opts[:'contact'] if !opts[:'contact'].nil?
  form_params['conf'] = opts[:'conf'] if !opts[:'conf'].nil?
  form_params['state'] = opts[:'state'] if !opts[:'state'].nil?
  form_params['lang'] = opts[:'lang'] if !opts[:'lang'].nil?

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

#users_id_user_resume_get(id_user, opts = {}) ⇒ Object

Get synthesis configuration of a specific user

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

  • (Object) 


2526
2527
2528
2529
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2526

def users_id_user_resume_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_resume_get_with_http_info(id_user, opts)
  data
end

#users_id_user_resume_get_with_http_info(id_user, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Get synthesis configuration of a specific user &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2536

def users_id_user_resume_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_resume_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_resume_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/resume'.sub('{' + 'id_user' + '}', id_user.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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_resume_post(id_user, opts = {}) ⇒ Object

Update synthesis configuration

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :resume_enabled (BOOLEAN) —

    whether the synthesis is activated or not

  • :resume_frequency (Integer) —

    frequency of the synthesis given in days

Returns:

  • (Object) 


2582
2583
2584
2585
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2582

def users_id_user_resume_post(id_user, opts = {})
  data, _status_code, _headers = users_id_user_resume_post_with_http_info(id_user, opts)
  data
end

#users_id_user_resume_post_with_http_info(id_user, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update synthesis configuration &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :resume_enabled (BOOLEAN) —

    whether the synthesis is activated or not

  • :resume_frequency (Integer) —

    frequency of the synthesis given in days

Returns:

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

    Object data, response status code and response headers



2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2594

def users_id_user_resume_post_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.users_id_user_resume_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling PFMApi.users_id_user_resume_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/resume'.sub('{' + 'id_user' + '}', id_user.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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['resume_enabled'] = opts[:'resume_enabled'] if !opts[:'resume_enabled'].nil?
  form_params['resume_frequency'] = opts[:'resume_frequency'] if !opts[:'resume_frequency'].nil?

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