Class: YNAB::PayeeLocationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PayeeLocationsApi

Returns a new instance of PayeeLocationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_payee_location_by_id(budget_id, payee_location_id, opts = {}) ⇒ PayeeLocationResponse

Single payee location Returns a single payee location

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)

  • payee_location_id —

    id of payee location

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

    the optional parameters

Returns:



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

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

#get_payee_location_by_id_with_http_info(budget_id, payee_location_id, opts = {}) ⇒ Array<(PayeeLocationResponse, Fixnum, Hash)>

Single payee location Returns a single payee location

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)

  • payee_location_id —

    id of payee location

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

    the optional parameters

Returns:

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

    PayeeLocationResponse 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/payee_locations_api.rb', line 39

def get_payee_location_by_id_with_http_info(budget_id, payee_location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeLocationsApi.get_payee_location_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 PayeeLocationsApi.get_payee_location_by_id"
  end
  # verify the required parameter 'payee_location_id' is set
  if @api_client.config.client_side_validation && payee_location_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_location_id' when calling PayeeLocationsApi.get_payee_location_by_id"
  end
  # resource path
  local_var_path = '/budgets/{budget_id}/payee_locations/{payee_location_id}'.sub('{' + 'budget_id' + '}', budget_id.to_s).sub('{' + 'payee_location_id' + '}', payee_location_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 => 'PayeeLocationResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayeeLocationsApi#get_payee_location_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payee_locations(budget_id, opts = {}) ⇒ PayeeLocationsResponse

List payee locations Returns all payee locations

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:



85
86
87
88
 
# File 'lib/ynab/api/payee_locations_api.rb', line 85

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

#get_payee_locations_by_payee(budget_id, payee_id, opts = {}) ⇒ PayeeLocationsResponse

List locations for a payee Returns all payee locations for the specified payee

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)

  • payee_id —

    id of payee

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/ynab/api/payee_locations_api.rb', line 138

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

#get_payee_locations_by_payee_with_http_info(budget_id, payee_id, opts = {}) ⇒ Array<(PayeeLocationsResponse, Fixnum, Hash)>

List locations for a payee Returns all payee locations for the specified payee

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)

  • payee_id —

    id of payee

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

    the optional parameters

Returns:

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

    PayeeLocationsResponse data, response status code and response headers



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/ynab/api/payee_locations_api.rb', line 149

def get_payee_locations_by_payee_with_http_info(budget_id, payee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeLocationsApi.get_payee_locations_by_payee ...'
  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 PayeeLocationsApi.get_payee_locations_by_payee"
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeLocationsApi.get_payee_locations_by_payee"
  end
  # resource path
  local_var_path = '/budgets/{budget_id}/payees/{payee_id}/payee_locations'.sub('{' + 'budget_id' + '}', budget_id.to_s).sub('{' + 'payee_id' + '}', payee_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 => 'PayeeLocationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayeeLocationsApi#get_payee_locations_by_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payee_locations_with_http_info(budget_id, opts = {}) ⇒ Array<(PayeeLocationsResponse, Fixnum, Hash)>

List payee locations Returns all payee locations

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

    PayeeLocationsResponse data, response status code and response headers



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
129
130
131
 
# File 'lib/ynab/api/payee_locations_api.rb', line 95

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