Class: MxPlatformRuby::BudgetsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/api/budgets_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BudgetsApi

Returns a new instance of BudgetsApi.



19
20
21
 
# File 'lib/mx-platform-ruby/api/budgets_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/mx-platform-ruby/api/budgets_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#users_user_guid_budgets_budget_guid_delete(user_guid, budget_guid, opts = {}) ⇒ nil

Delete a budget Delete a budget.

Parameters:

  • user_guid (String) —

    The unique identifier for the budget. Defined by MX.

  • budget_guid (String) —

    The unique identifier for the budget. Defined by MX.

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 28

def users_user_guid_budgets_budget_guid_delete(user_guid, budget_guid, opts = {})
  users_user_guid_budgets_budget_guid_delete_with_http_info(user_guid, budget_guid, opts)
  nil
end

#users_user_guid_budgets_budget_guid_delete_with_http_info(user_guid, budget_guid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a budget Delete a budget.

Parameters:

  • user_guid (String) —

    The unique identifier for the budget. Defined by MX.

  • budget_guid (String) —

    The unique identifier for the budget. Defined by MX.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 39

def users_user_guid_budgets_budget_guid_delete_with_http_info(user_guid, budget_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_budget_guid_delete ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_delete"
  end
  # verify the required parameter 'budget_guid' is set
  if @api_client.config.client_side_validation && budget_guid.nil?
    fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_delete"
  end
  # resource path
  local_var_path = '/users/{user_guid}/budgets/{budget_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'budget_guid' + '}', CGI.escape(budget_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"BudgetsApi.users_user_guid_budgets_budget_guid_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_budget_guid_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_budgets_budget_guid_get(budget_guid, user_guid, opts = {}) ⇒ BudgetResponseBody

Read a specific budget Read a specific budget.

Parameters:

  • budget_guid (String) —

    The unique identifier for the budget. Defined by MX.

  • user_guid (String) —

    The unique identifier for the budget. Defined by MX.

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 95

def users_user_guid_budgets_budget_guid_get(budget_guid, user_guid, opts = {})
  data, _status_code, _headers = users_user_guid_budgets_budget_guid_get_with_http_info(budget_guid, user_guid, opts)
  data
end

#users_user_guid_budgets_budget_guid_get_with_http_info(budget_guid, user_guid, opts = {}) ⇒ Array<(BudgetResponseBody, Integer, Hash)>

Read a specific budget Read a specific budget.

Parameters:

  • budget_guid (String) —

    The unique identifier for the budget. Defined by MX.

  • user_guid (String) —

    The unique identifier for the budget. Defined by MX.

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

    the optional parameters

Returns:

  • (Array<(BudgetResponseBody, Integer, Hash)>) —

    BudgetResponseBody data, response status code and response headers



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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 106

def users_user_guid_budgets_budget_guid_get_with_http_info(budget_guid, user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_budget_guid_get ...'
  end
  # verify the required parameter 'budget_guid' is set
  if @api_client.config.client_side_validation && budget_guid.nil?
    fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_get"
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_get"
  end
  # resource path
  local_var_path = '/users/{user_guid}/budgets/{budget_guid}'.sub('{' + 'budget_guid' + '}', CGI.escape(budget_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"BudgetsApi.users_user_guid_budgets_budget_guid_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_budget_guid_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_budgets_budget_guid_put(user_guid, budget_guid, opts = {}) ⇒ BudgetResponseBody

Update a specific budget Update a specific budget.

Parameters:

  • user_guid (String) —

    The unique identifier for the budget. Defined by MX.

  • budget_guid (String) —

    The unique identifier for the budget. Defined by MX.

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

    the optional parameters

Options Hash (opts):

Returns:



165
166
167
168
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 165

def users_user_guid_budgets_budget_guid_put(user_guid, budget_guid, opts = {})
  data, _status_code, _headers = users_user_guid_budgets_budget_guid_put_with_http_info(user_guid, budget_guid, opts)
  data
end

#users_user_guid_budgets_budget_guid_put_with_http_info(user_guid, budget_guid, opts = {}) ⇒ Array<(BudgetResponseBody, Integer, Hash)>

Update a specific budget Update a specific budget.

Parameters:

  • user_guid (String) —

    The unique identifier for the budget. Defined by MX.

  • budget_guid (String) —

    The unique identifier for the budget. Defined by MX.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(BudgetResponseBody, Integer, Hash)>) —

    BudgetResponseBody data, response status code and response headers



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 177

def users_user_guid_budgets_budget_guid_put_with_http_info(user_guid, budget_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_budget_guid_put ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_put"
  end
  # verify the required parameter 'budget_guid' is set
  if @api_client.config.client_side_validation && budget_guid.nil?
    fail ArgumentError, "Missing the required parameter 'budget_guid' when calling BudgetsApi.users_user_guid_budgets_budget_guid_put"
  end
  # resource path
  local_var_path = '/users/{user_guid}/budgets/{budget_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'budget_guid' + '}', CGI.escape(budget_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'budget_update_request_body'])

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"BudgetsApi.users_user_guid_budgets_budget_guid_put",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_budget_guid_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_budgets_generate_post(user_guid, opts = {}) ⇒ BudgetResponseBody

Auto-generate budgets This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the ‘user` has at least one `transaction` in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one "Bills & Utilities" `transaction` in both January and February, a budget will be generated for "Bills & Utilities." If there are two "Bills & Utilities" transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the `user` meet the above criteria, a `422 Unprocessable Entity` error will be returned with status code 4221 along with the message, `There aren’t enough transactions to automatically create any budgets`.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:



239
240
241
242
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 239

def users_user_guid_budgets_generate_post(user_guid, opts = {})
  data, _status_code, _headers = users_user_guid_budgets_generate_post_with_http_info(user_guid, opts)
  data
end

#users_user_guid_budgets_generate_post_with_http_info(user_guid, opts = {}) ⇒ Array<(BudgetResponseBody, Integer, Hash)>

Auto-generate budgets This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the &#x60;user&#x60; has at least one &#x60;transaction&#x60; in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one &quot;Bills &amp; Utilities&quot; &#x60;transaction&#x60; in both January and February, a budget will be generated for &quot;Bills &amp; Utilities.&quot; If there are two &quot;Bills &amp; Utilities&quot; transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the &#x60;user&#x60; meet the above criteria, a &#x60;422 Unprocessable Entity&#x60; error will be returned with status code 4221 along with the message, &#x60;There aren&#39;t enough transactions to automatically create any budgets&#x60;.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:

  • (Array<(BudgetResponseBody, Integer, Hash)>) —

    BudgetResponseBody data, response status code and response headers



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
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 249

def users_user_guid_budgets_generate_post_with_http_info(user_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_generate_post ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_generate_post"
  end
  # resource path
  local_var_path = '/users/{user_guid}/budgets/generate'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"BudgetsApi.users_user_guid_budgets_generate_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_generate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_budgets_get(user_guid, opts = {}) ⇒ BudgetResponseBody

List all budgets List all budgets

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:



302
303
304
305
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 302

def users_user_guid_budgets_get(user_guid, opts = {})
  data, _status_code, _headers = users_user_guid_budgets_get_with_http_info(user_guid, opts)
  data
end

#users_user_guid_budgets_get_with_http_info(user_guid, opts = {}) ⇒ Array<(BudgetResponseBody, Integer, Hash)>

List all budgets List all budgets

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:

  • (Array<(BudgetResponseBody, Integer, Hash)>) —

    BudgetResponseBody data, response status code and response headers



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 312

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

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"BudgetsApi.users_user_guid_budgets_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_guid_budgets_post(user_guid, budget_create_request_body, opts = {}) ⇒ BudgetResponseBody

Create a budget Create a budget. This endpoint accepts the optional ‘MX-Skip-Webhook` header and `skip_webhook` parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for "Gas", but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:



366
367
368
369
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 366

def users_user_guid_budgets_post(user_guid, budget_create_request_body, opts = {})
  data, _status_code, _headers = users_user_guid_budgets_post_with_http_info(user_guid, budget_create_request_body, opts)
  data
end

#users_user_guid_budgets_post_with_http_info(user_guid, budget_create_request_body, opts = {}) ⇒ Array<(BudgetResponseBody, Integer, Hash)>

Create a budget Create a budget. This endpoint accepts the optional &#x60;MX-Skip-Webhook&#x60; header and &#x60;skip_webhook&#x60; parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for &quot;Gas&quot;, but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.

Parameters:

  • user_guid (String) —

    The unique identifier for the user. Defined by MX.

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

    the optional parameters

Returns:

  • (Array<(BudgetResponseBody, Integer, Hash)>) —

    BudgetResponseBody data, response status code and response headers



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/mx-platform-ruby/api/budgets_api.rb', line 377

def users_user_guid_budgets_post_with_http_info(user_guid, budget_create_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.users_user_guid_budgets_post ...'
  end
  # verify the required parameter 'user_guid' is set
  if @api_client.config.client_side_validation && user_guid.nil?
    fail ArgumentError, "Missing the required parameter 'user_guid' when calling BudgetsApi.users_user_guid_budgets_post"
  end
  # verify the required parameter 'budget_create_request_body' is set
  if @api_client.config.client_side_validation && budget_create_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'budget_create_request_body' when calling BudgetsApi.users_user_guid_budgets_post"
  end
  # resource path
  local_var_path = '/users/{user_guid}/budgets'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(budget_create_request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'BudgetResponseBody'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"BudgetsApi.users_user_guid_budgets_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#users_user_guid_budgets_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end