Class: YNAB::DeprecatedApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ynab/api/deprecated_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeprecatedApi

Returns a new instance of DeprecatedApi.



19
20
21
 
# File 'lib/ynab/api/deprecated_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/ynab/api/deprecated_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#bulk_create_transactions(budget_id, transactions, opts = {}) ⇒ BulkResponse

Bulk create transactions Creates multiple transactions. Although this endpoint is still supported, it is recommended to use ‘POST /budgets/budget_id/transactions’ to create multiple transactions.

Parameters:

  • budget_id —

    The id of the budget ("last-used" can be used to specify the last used budget and "default" can be used if default budget selection is enabled (see: api.youneedabudget.com/#oauth-default-budget)

  • transactions —

    The list of transactions to create

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/ynab/api/deprecated_api.rb', line 28

def bulk_create_transactions(budget_id, transactions, opts = {})
  data, _status_code, _headers = bulk_create_transactions_with_http_info(budget_id, transactions, opts)
  data
end

#bulk_create_transactions_with_http_info(budget_id, transactions, opts = {}) ⇒ Array<(BulkResponse, Fixnum, Hash)>

Bulk create transactions Creates multiple transactions. Although this endpoint is still supported, it is recommended to use &#39;POST /budgets/budget_id/transactions&#39; to create multiple transactions.

Parameters:

  • budget_id —

    The id of the budget (&quot;last-used&quot; can be used to specify the last used budget and &quot;default&quot; can be used if default budget selection is enabled (see: api.youneedabudget.com/#oauth-default-budget)

  • transactions —

    The list of transactions to create

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

    the optional parameters

Returns:

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

    BulkResponse data, 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
 
# File 'lib/ynab/api/deprecated_api.rb', line 39

def bulk_create_transactions_with_http_info(budget_id, transactions, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeprecatedApi.bulk_create_transactions ...'
  end
  # verify the required parameter 'budget_id' is set
  if @api_client.config.client_side_validation && budget_id.nil?
    fail ArgumentError, "Missing the required parameter 'budget_id' when calling DeprecatedApi.bulk_create_transactions"
  end
  # verify the required parameter 'transactions' is set
  if @api_client.config.client_side_validation && transactions.nil?
    fail ArgumentError, "Missing the required parameter 'transactions' when calling DeprecatedApi.bulk_create_transactions"
  end
  # resource path
  local_var_path = '/budgets/{budget_id}/transactions/bulk'.sub('{' + 'budget_id' + '}', budget_id.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'])

  # form parameters
  form_params = {}

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