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_token_delete(opts = {}) ⇒ nil

Remove user access This endpoint removes the token in use.

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_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



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_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(username, password, application, opts = {}) ⇒ InlineResponse2005

Login to API with credentials Request a new user token by giving an username and a password.

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:



339
340
341
342
 
# File 'lib/budgea_client/api/pfm_api.rb', line 339

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

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

Login to API with credentials Request a new user token by giving an username and a password.&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;

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

    InlineResponse2005 data, response status code and response headers



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/budgea_client/api/pfm_api.rb', line 352

def auth_token_post_with_http_info(username, password, application, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PFMApi.auth_token_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_token_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_token_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_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['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,
    :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) 


407
408
409
410
 
# File 'lib/budgea_client/api/pfm_api.rb', line 407

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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/budgea_client/api/pfm_api.rb', line 416

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) 


459
460
461
462
 
# File 'lib/budgea_client/api/pfm_api.rb', line 459

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



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/budgea_client/api/pfm_api.rb', line 473

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 = {}) ⇒ InlineResponse20027

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:



525
526
527
528
 
# File 'lib/budgea_client/api/pfm_api.rb', line 525

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

    InlineResponse20027 data, response status code and response headers



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/budgea_client/api/pfm_api.rb', line 537

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 => 'InlineResponse20027')
  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:



589
590
591
592
 
# File 'lib/budgea_client/api/pfm_api.rb', line 589

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



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/budgea_client/api/pfm_api.rb', line 602

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:



663
664
665
666
 
# File 'lib/budgea_client/api/pfm_api.rb', line 663

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



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
 
# File 'lib/budgea_client/api/pfm_api.rb', line 681

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:



746
747
748
749
 
# File 'lib/budgea_client/api/pfm_api.rb', line 746

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



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/budgea_client/api/pfm_api.rb', line 763

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) 


817
818
819
820
 
# File 'lib/budgea_client/api/pfm_api.rb', line 817

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



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/budgea_client/api/pfm_api.rb', line 827

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) 


876
877
878
879
 
# File 'lib/budgea_client/api/pfm_api.rb', line 876

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



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'lib/budgea_client/api/pfm_api.rb', line 891

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) 


943
944
945
946
 
# File 'lib/budgea_client/api/pfm_api.rb', line 943

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



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
 
# File 'lib/budgea_client/api/pfm_api.rb', line 956

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) 


1007
1008
1009
1010
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1007

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



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1022

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 = {}) ⇒ InlineResponse20027

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:



1079
1080
1081
1082
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1079

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

    InlineResponse20027 data, response status code and response headers



1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1092

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 => 'InlineResponse20027')
  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:



1149
1150
1151
1152
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1149

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



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1163

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:



1229
1230
1231
1232
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1229

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



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1248

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:



1318
1319
1320
1321
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1318

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



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1336

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) 


1398
1399
1400
1401
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1398

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



1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1412

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 = {}) ⇒ InlineResponse20036

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:



1463
1464
1465
1466
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1463

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

    InlineResponse20036 data, response status code and response headers



1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1474

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 => 'InlineResponse20036')
  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:



1521
1522
1523
1524
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1521

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



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1533

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:



1584
1585
1586
1587
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1584

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



1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1596

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:



1650
1651
1652
1653
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1650

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



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1665

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:



1729
1730
1731
1732
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1729

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



1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1743

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) 


1799
1800
1801
1802
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1799

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



1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1809

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:



1853
1854
1855
1856
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1853

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



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1864

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 = {}) ⇒ InlineResponse20027

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:



1910
1911
1912
1913
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1910

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

    InlineResponse20027 data, response status code and response headers



1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1921

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 => 'InlineResponse20027')
  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:



1968
1969
1970
1971
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1968

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



1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'lib/budgea_client/api/pfm_api.rb', line 1980

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:



2036
2037
2038
2039
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2036

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



2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2053

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:



2113
2114
2115
2116
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2113

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



2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2129

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 = {}) ⇒ InlineResponse20037

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:



2180
2181
2182
2183
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2180

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

    InlineResponse20037 data, response status code and response headers



2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2191

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 => 'InlineResponse20037')
  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:



2238
2239
2240
2241
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2238

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



2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2250

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:



2300
2301
2302
2303
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2300

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



2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2311

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:



2357
2358
2359
2360
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2357

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



2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2368

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:



2421
2422
2423
2424
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2421

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



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2439

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) 


2491
2492
2493
2494
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2491

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



2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2501

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) 


2547
2548
2549
2550
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2547

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



2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
 
# File 'lib/budgea_client/api/pfm_api.rb', line 2559

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