Class: FireflyIIIClient::CategoriesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CategoriesApi

Returns a new instance of CategoriesApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete a category. Delete a category. Transactions will not be removed.

Parameters:

  • id (Integer) —

    The ID of the category.

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_category(id, opts = {})
  delete_category_with_http_info(id, opts)
  nil
end

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

Delete a category. Delete a category. Transactions will not be removed.

Parameters:

  • id (Integer) —

    The ID of the category.

  • 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/categories_api.rb', line 37

def delete_category_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.delete_category ...'
  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 CategoriesApi.delete_category"
  end
  # resource path
  local_var_path = '/api/v1/categories/{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 => :"CategoriesApi.delete_category",
    :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: CategoriesApi#delete_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_category(id, opts = {}) ⇒ CategorySingle

Get a single category. Get a single category.

Parameters:

  • id (Integer) —

    The ID of the category.

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

    the optional parameters

Returns:



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

def get_category(id, opts = {})
  data, _status_code, _headers = get_category_with_http_info(id, opts)
  data
end

#get_category_with_http_info(id, opts = {}) ⇒ Array<(CategorySingle, Integer, Hash)>

Get a single category. Get a single category.

Parameters:

  • id (Integer) —

    The ID of the category.

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

    the optional parameters

Returns:

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

    CategorySingle 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/categories_api.rb', line 98

def get_category_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.get_category ...'
  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 CategoriesApi.get_category"
  end
  # resource path
  local_var_path = '/api/v1/categories/{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] || 'CategorySingle'

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

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

#list_category(opts = {}) ⇒ CategoryArray

List all categories. List all categories.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:



151
152
153
154
 
# File 'lib/firefly_iii_client/api/categories_api.rb', line 151

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

#list_category_with_http_info(opts = {}) ⇒ Array<(CategoryArray, Integer, Hash)>

List all categories. List all categories.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

Returns:

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

    CategoryArray data, response status code and response headers



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
 
# File 'lib/firefly_iii_client/api/categories_api.rb', line 161

def list_category_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.list_category ...'
  end
  # resource path
  local_var_path = '/api/v1/categories'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'CategoryArray'

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

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

#list_transaction_by_category(id, opts = {}) ⇒ TransactionArray

List all transactions in a category. List all transactions in a category, optionally limited to the date ranges specified.

Parameters:

  • id (Integer) —

    The ID of the category.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50.

  • :start (Date) —

    A date formatted YYYY-MM-DD, to limit the result list.

  • :_end (Date) —

    A date formatted YYYY-MM-DD, to limit the result list.

  • :type (TransactionTypeFilter) —

    Optional filter on the transaction type(s) returned

Returns:



215
216
217
218
 
# File 'lib/firefly_iii_client/api/categories_api.rb', line 215

def list_transaction_by_category(id, opts = {})
  data, _status_code, _headers = list_transaction_by_category_with_http_info(id, opts)
  data
end

#list_transaction_by_category_with_http_info(id, opts = {}) ⇒ Array<(TransactionArray, Integer, Hash)>

List all transactions in a category. List all transactions in a category, optionally limited to the date ranges specified.

Parameters:

  • id (Integer) —

    The ID of the category.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50.

  • :start (Date) —

    A date formatted YYYY-MM-DD, to limit the result list.

  • :_end (Date) —

    A date formatted YYYY-MM-DD, to limit the result list.

  • :type (TransactionTypeFilter) —

    Optional filter on the transaction type(s) returned

Returns:

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

    TransactionArray data, response status code and response headers



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
276
277
278
279
 
# File 'lib/firefly_iii_client/api/categories_api.rb', line 229

def list_transaction_by_category_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.list_transaction_by_category ...'
  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 CategoriesApi.list_transaction_by_category"
  end
  # resource path
  local_var_path = '/api/v1/categories/{id}/transactions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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] || 'TransactionArray'

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

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

#store_category(category, opts = {}) ⇒ CategorySingle

Store a new category Creates a new category. The data required can be submitted as a JSON body or as a list of parameters.

Parameters:

  • category (Category) —

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

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

    the optional parameters

Returns:



286
287
288
289
 
# File 'lib/firefly_iii_client/api/categories_api.rb', line 286

def store_category(category, opts = {})
  data, _status_code, _headers = store_category_with_http_info(category, opts)
  data
end

#store_category_with_http_info(category, opts = {}) ⇒ Array<(CategorySingle, Integer, Hash)>

Store a new category Creates a new category. The data required can be submitted as a JSON body or as a list of parameters.

Parameters:

  • category (Category) —

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

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

    the optional parameters

Returns:

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

    CategorySingle data, response status code and response headers



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
 
# File 'lib/firefly_iii_client/api/categories_api.rb', line 296

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

  # 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(category)

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

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

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

#update_category(id, category, opts = {}) ⇒ CategorySingle

Update existing category. Update existing category.

Parameters:

  • id (Integer) —

    The ID of the category.

  • category (Category) —

    JSON array with updated category information. See the model for the exact specifications.

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

    the optional parameters

Returns:



352
353
354
355
 
# File 'lib/firefly_iii_client/api/categories_api.rb', line 352

def update_category(id, category, opts = {})
  data, _status_code, _headers = update_category_with_http_info(id, category, opts)
  data
end

#update_category_with_http_info(id, category, opts = {}) ⇒ Array<(CategorySingle, Integer, Hash)>

Update existing category. Update existing category.

Parameters:

  • id (Integer) —

    The ID of the category.

  • category (Category) —

    JSON array with updated category information. See the model for the exact specifications.

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

    the optional parameters

Returns:

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

    CategorySingle data, response status code and response headers



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
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/firefly_iii_client/api/categories_api.rb', line 363

def update_category_with_http_info(id, category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CategoriesApi.update_category ...'
  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 CategoriesApi.update_category"
  end
  # verify the required parameter 'category' is set
  if @api_client.config.client_side_validation && category.nil?
    fail ArgumentError, "Missing the required parameter 'category' when calling CategoriesApi.update_category"
  end
  # resource path
  local_var_path = '/api/v1/categories/{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(category)

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

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

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