Class: YNAB::AccountsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountsApi

Returns a new instance of AccountsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_account_by_id(budget_id, account_id, opts = {}) ⇒ AccountResponse

Single account Returns a single account

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)

  • account_id —

    The id of the account

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

    the optional parameters

Returns:



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

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

#get_account_by_id_with_http_info(budget_id, account_id, opts = {}) ⇒ Array<(AccountResponse, Fixnum, Hash)>

Single account Returns a single account

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)

  • account_id —

    The id of the account

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

    the optional parameters

Returns:

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

    AccountResponse 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/accounts_api.rb', line 39

def (budget_id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_account_by_id ...'
  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 AccountsApi.get_account_by_id"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_by_id"
  end
  # resource path
  local_var_path = '/budgets/{budget_id}/accounts/{account_id}'.sub('{' + 'budget_id' + '}', budget_id.to_s).sub('{' + 'account_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 = nil
  auth_names = ['bearer']
  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 => 'AccountResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_account_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_accounts(budget_id, opts = {}) ⇒ AccountsResponse

Account list Returns all accounts

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)

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

    the optional parameters

Options Hash (opts):

  • :last_knowledge_of_server (Integer) —

    The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns:



86
87
88
89
 
# File 'lib/ynab/api/accounts_api.rb', line 86

def get_accounts(budget_id, opts = {})
  data, _status_code, _headers = get_accounts_with_http_info(budget_id, opts)
  data
end

#get_accounts_with_http_info(budget_id, opts = {}) ⇒ Array<(AccountsResponse, Fixnum, Hash)>

Account list Returns all accounts

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)

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

    the optional parameters

Options Hash (opts):

  • :last_knowledge_of_server (Integer) —

    The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.

Returns:

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

    AccountsResponse data, response status code and response headers



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
 
# File 'lib/ynab/api/accounts_api.rb', line 97

def get_accounts_with_http_info(budget_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...'
  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 AccountsApi.get_accounts"
  end
  # resource path
  local_var_path = '/budgets/{budget_id}/accounts'.sub('{' + 'budget_id' + '}', budget_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'last_knowledge_of_server'] = opts[:'last_knowledge_of_server'] if !opts[:'last_knowledge_of_server'].nil?

  # 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 = nil
  auth_names = ['bearer']
  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 => 'AccountsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end