Class: YNAB::BudgetsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ynab/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/ynab/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/ynab/api/budgets_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_budget_by_id(budget_id, opts = {}) ⇒ BudgetDetailResponse

Single budget Returns a single budget with all related entities. This resource is effectively a full budget export.

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)

  • 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:



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

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

#get_budget_by_id_with_http_info(budget_id, opts = {}) ⇒ Array<(BudgetDetailResponse, Fixnum, Hash)>

Single budget Returns a single budget with all related entities. This resource is effectively a full budget export.

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<(BudgetDetailResponse, Fixnum, Hash)>) —

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

def get_budget_by_id_with_http_info(budget_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budget_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 BudgetsApi.get_budget_by_id"
  end
  # resource path
  local_var_path = '/budgets/{budget_id}'.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 => 'BudgetDetailResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#get_budget_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_budget_settings_by_id(budget_id, opts = {}) ⇒ BudgetSettingsResponse

Budget Settings Returns settings for a budget

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

Returns:



82
83
84
85
 
# File 'lib/ynab/api/budgets_api.rb', line 82

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

#get_budget_settings_by_id_with_http_info(budget_id, opts = {}) ⇒ Array<(BudgetSettingsResponse, Fixnum, Hash)>

Budget Settings Returns settings for a budget

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

Returns:

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

    BudgetSettingsResponse data, response status code and response headers



92
93
94
95
96
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
 
# File 'lib/ynab/api/budgets_api.rb', line 92

def get_budget_settings_by_id_with_http_info(budget_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budget_settings_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 BudgetsApi.get_budget_settings_by_id"
  end
  # resource path
  local_var_path = '/budgets/{budget_id}/settings'.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 = 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 => 'BudgetSettingsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#get_budget_settings_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_budgets(opts = {}) ⇒ BudgetSummaryResponse

List budgets Returns budgets list with summary information

Parameters:

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

    the optional parameters

Returns:



133
134
135
136
 
# File 'lib/ynab/api/budgets_api.rb', line 133

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

#get_budgets_with_http_info(opts = {}) ⇒ Array<(BudgetSummaryResponse, Fixnum, Hash)>

List budgets Returns budgets list with summary information

Parameters:

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

    the optional parameters

Returns:

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

    BudgetSummaryResponse data, response status code and response headers



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/ynab/api/budgets_api.rb', line 142

def get_budgets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BudgetsApi.get_budgets ...'
  end
  # resource path
  local_var_path = '/budgets'

  # 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 => 'BudgetSummaryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BudgetsApi#get_budgets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end