Class: FireflyIIIClient::AvailableBudgetsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/firefly_iii_client/api/available_budgets_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AvailableBudgetsApi

Returns a new instance of AvailableBudgetsApi.



19
20
21
 
# File 'lib/firefly_iii_client/api/available_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/firefly_iii_client/api/available_budgets_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_available_budget(id, opts = {}) ⇒ nil

Delete an available budget. Delete an available budget. Not much more to say.

Parameters:

  • id (Integer) —

    The ID of the available budget.

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 27

def delete_available_budget(id, opts = {})
  delete_available_budget_with_http_info(id, opts)
  nil
end

#delete_available_budget_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an available budget. Delete an available budget. Not much more to say.

Parameters:

  • id (Integer) —

    The ID of the available budget.

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, 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
76
77
78
79
80
81
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 37

def delete_available_budget_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AvailableBudgetsApi.delete_available_budget ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AvailableBudgetsApi.delete_available_budget"
  end
  # resource path
  local_var_path = '/api/v1/available_budgets/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"AvailableBudgetsApi.delete_available_budget",
    :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: AvailableBudgetsApi#delete_available_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_available_budget(id, opts = {}) ⇒ AvailableBudgetSingle

Get a single available budget. Get a single available budget, by ID.

Parameters:

  • id (Integer) —

    The ID of the available budget.

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 88

def get_available_budget(id, opts = {})
  data, _status_code, _headers = get_available_budget_with_http_info(id, opts)
  data
end

#get_available_budget_with_http_info(id, opts = {}) ⇒ Array<(AvailableBudgetSingle, Integer, Hash)>

Get a single available budget. Get a single available budget, by ID.

Parameters:

  • id (Integer) —

    The ID of the available budget.

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

    the optional parameters

Returns:

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

    AvailableBudgetSingle data, response status code and response headers



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
138
139
140
141
142
143
144
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 98

def get_available_budget_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AvailableBudgetsApi.get_available_budget ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AvailableBudgetsApi.get_available_budget"
  end
  # resource path
  local_var_path = '/api/v1/available_budgets/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"AvailableBudgetsApi.get_available_budget",
    :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: AvailableBudgetsApi#get_available_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_available_budget(opts = {}) ⇒ AvailableBudgetArray

List all available budget amounts. Firefly III allows users to set the amount that is available to be budgeted in so-called "available budgets". For example, the user could have 1200,- available to be divided during the coming month. This amount is used on the /budgets page. This endpoint returns all of these amounts and the periods for which they are set.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

  • :start (Date) —

    A date formatted YYYY-MM-DD.

  • :_end (Date) —

    A date formatted YYYY-MM-DD.

Returns:



153
154
155
156
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 153

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

#list_available_budget_with_http_info(opts = {}) ⇒ Array<(AvailableBudgetArray, Integer, Hash)>

List all available budget amounts. Firefly III allows users to set the amount that is available to be budgeted in so-called &quot;available budgets&quot;. For example, the user could have 1200,- available to be divided during the coming month. This amount is used on the /budgets page. This endpoint returns all of these amounts and the periods for which they are set.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

  • :start (Date) —

    A date formatted YYYY-MM-DD.

  • :_end (Date) —

    A date formatted YYYY-MM-DD.

Returns:

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

    AvailableBudgetArray data, response status code and response headers



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
209
210
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 165

def list_available_budget_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AvailableBudgetsApi.list_available_budget ...'
  end
  # resource path
  local_var_path = '/api/v1/available_budgets'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"AvailableBudgetsApi.list_available_budget",
    :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: AvailableBudgetsApi#list_available_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#store_available_budget(available_budget, opts = {}) ⇒ AvailableBudgetSingle

Store a new available budget Creates a new available budget for a specified period. The data required can be submitted as a JSON body or as a list of parameters.

Parameters:

  • available_budget (AvailableBudget) —

    JSON array or key&#x3D;value pairs with the necessary available budget information. See the model for the exact specifications.

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

    the optional parameters

Returns:



217
218
219
220
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 217

def store_available_budget(available_budget, opts = {})
  data, _status_code, _headers = store_available_budget_with_http_info(available_budget, opts)
  data
end

#store_available_budget_with_http_info(available_budget, opts = {}) ⇒ Array<(AvailableBudgetSingle, Integer, Hash)>

Store a new available budget Creates a new available budget for a specified period. The data required can be submitted as a JSON body or as a list of parameters.

Parameters:

  • available_budget (AvailableBudget) —

    JSON array or key&#x3D;value pairs with the necessary available budget information. See the model for the exact specifications.

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

    the optional parameters

Returns:

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

    AvailableBudgetSingle data, response status code and response headers



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 227

def store_available_budget_with_http_info(available_budget, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AvailableBudgetsApi.store_available_budget ...'
  end
  # verify the required parameter 'available_budget' is set
  if @api_client.config.client_side_validation && available_budget.nil?
    fail ArgumentError, "Missing the required parameter 'available_budget' when calling AvailableBudgetsApi.store_available_budget"
  end
  # resource path
  local_var_path = '/api/v1/available_budgets'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"AvailableBudgetsApi.store_available_budget",
    :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: AvailableBudgetsApi#store_available_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_available_budget(id, available_budget, opts = {}) ⇒ AvailableBudgetSingle

Update existing available budget, to change for example the date range of the amount or the amount itself. Update existing available budget.

Parameters:

  • id (Integer) —

    The ID of the object.X

  • available_budget (AvailableBudget) —

    JSON array or form value with updated available budget information. See the model for the exact specifications.

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

    the optional parameters

Returns:



283
284
285
286
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 283

def update_available_budget(id, available_budget, opts = {})
  data, _status_code, _headers = update_available_budget_with_http_info(id, available_budget, opts)
  data
end

#update_available_budget_with_http_info(id, available_budget, opts = {}) ⇒ Array<(AvailableBudgetSingle, Integer, Hash)>

Update existing available budget, to change for example the date range of the amount or the amount itself. Update existing available budget.

Parameters:

  • id (Integer) —

    The ID of the object.X

  • available_budget (AvailableBudget) —

    JSON array or form value with updated available budget information. See the model for the exact specifications.

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

    the optional parameters

Returns:

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

    AvailableBudgetSingle data, response status code and response headers



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/firefly_iii_client/api/available_budgets_api.rb', line 294

def update_available_budget_with_http_info(id, available_budget, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AvailableBudgetsApi.update_available_budget ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AvailableBudgetsApi.update_available_budget"
  end
  # verify the required parameter 'available_budget' is set
  if @api_client.config.client_side_validation && available_budget.nil?
    fail ArgumentError, "Missing the required parameter 'available_budget' when calling AvailableBudgetsApi.update_available_budget"
  end
  # resource path
  local_var_path = '/api/v1/available_budgets/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"AvailableBudgetsApi.update_available_budget",
    :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: AvailableBudgetsApi#update_available_budget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end