Class: MoneyKit::LinksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/api/links_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LinksApi 



17
18
19
 
# File 'lib/moneykit/api/links_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/moneykit/api/links_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

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

/links/id Deletes this link and disables its access token. <p>After deletion, the link id and access token are no longer valid and cannot be used to access any data that was associated with it.

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


27
28
29
30
 
# File 'lib/moneykit/api/links_api.rb', line 27

def disconnect(id, opts = {})
  disconnect_with_http_info(id, opts)
  nil
end

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

/links/id Deletes this link and disables its access token. &lt;p&gt;After deletion, the link id and access token are no longer valid and cannot be used to access any data that was associated with it.

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


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
82
83
84
 
# File 'lib/moneykit/api/links_api.rb', line 38

def disconnect_with_http_info(id, opts = {})
  @api_client.config.logger.debug 'Calling API: LinksApi.disconnect ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    raise ArgumentError, "Missing the required parameter 'id' when calling LinksApi.disconnect"
  end

  # resource path
  local_var_path = '/links/{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'])
  header_params[:'moneykit-version'] = opts[:moneykit_version] unless opts[:moneykit_version].nil?

  # 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] || ['OAuth2ClientCredentials']

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

#get_link(id, opts = {}) ⇒ LinkResponse

/links/id Fetches details about a link.

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


92
93
94
95
 
# File 'lib/moneykit/api/links_api.rb', line 92

def get_link(id, opts = {})
  data, _status_code, _headers = get_link_with_http_info(id, opts)
  data
end

#get_link_with_http_info(id, opts = {}) ⇒ Array<(LinkResponse, Integer, Hash)>

/links/id Fetches details about a link.

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


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
145
146
147
148
149
 
# File 'lib/moneykit/api/links_api.rb', line 103

def get_link_with_http_info(id, opts = {})
  @api_client.config.logger.debug 'Calling API: LinksApi.get_link ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    raise ArgumentError, "Missing the required parameter 'id' when calling LinksApi.get_link"
  end

  # resource path
  local_var_path = '/links/{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'])
  header_params[:'moneykit-version'] = opts[:moneykit_version] unless opts[:moneykit_version].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#get_user_links(id, opts = {}) ⇒ GetUserLinksResponse

/users/id/links Fetches all links belonging to a <a href=#operation/get_user_accounts>user</a>.

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


157
158
159
160
 
# File 'lib/moneykit/api/links_api.rb', line 157

def get_user_links(id, opts = {})
  data, _status_code, _headers = get_user_links_with_http_info(id, opts)
  data
end

#get_user_links_with_http_info(id, opts = {}) ⇒ Array<(GetUserLinksResponse, Integer, Hash)>

/users/id/links Fetches all links belonging to a &lt;a href&#x3D;#operation/get_user_accounts&gt;user&lt;/a&gt;.

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


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
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/moneykit/api/links_api.rb', line 168

def get_user_links_with_http_info(id, opts = {})
  @api_client.config.logger.debug 'Calling API: LinksApi.get_user_links ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    raise ArgumentError, "Missing the required parameter 'id' when calling LinksApi.get_user_links"
  end

  # resource path
  local_var_path = '/users/{id}/links'.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'])
  header_params[:'moneykit-version'] = opts[:moneykit_version] unless opts[:moneykit_version].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#reset_login(id, opts = {}) ⇒ LinkResponse

Force a "relink required" state on a link (Test only).

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


221
222
223
224
 
# File 'lib/moneykit/api/links_api.rb', line 221

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

#reset_login_with_http_info(id, opts = {}) ⇒ Array<(LinkResponse, Integer, Hash)>

Force a &quot;relink required&quot; state on a link (Test only).

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


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
 
# File 'lib/moneykit/api/links_api.rb', line 231

def (id, opts = {})
  @api_client.config.logger.debug 'Calling API: LinksApi.reset_login ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    raise ArgumentError, "Missing the required parameter 'id' when calling LinksApi.reset_login"
  end

  # resource path
  local_var_path = '/links/{id}/reset'.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'])
  header_params[:'moneykit-version'] = opts[:moneykit_version] unless opts[:moneykit_version].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#update_link(id, update_link_request, opts = {}) ⇒ LinkResponse

/links/id Updates the link configuration.

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


286
287
288
289
 
# File 'lib/moneykit/api/links_api.rb', line 286

def update_link(id, update_link_request, opts = {})
  data, _status_code, _headers = update_link_with_http_info(id, update_link_request, opts)
  data
end

#update_link_with_http_info(id, update_link_request, opts = {}) ⇒ Array<(LinkResponse, Integer, Hash)>

/links/id Updates the link configuration.

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18' 


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
345
346
347
348
349
350
351
 
# File 'lib/moneykit/api/links_api.rb', line 298

def update_link_with_http_info(id, update_link_request, opts = {})
  @api_client.config.logger.debug 'Calling API: LinksApi.update_link ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    raise ArgumentError, "Missing the required parameter 'id' when calling LinksApi.update_link"
  end
  # verify the required parameter 'update_link_request' is set
  if @api_client.config.client_side_validation && update_link_request.nil?
    raise ArgumentError, "Missing the required parameter 'update_link_request' when calling LinksApi.update_link"
  end

  # resource path
  local_var_path = '/links/{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'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:'moneykit-version'] = opts[:moneykit_version] unless opts[:moneykit_version].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_link_request)

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

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

  new_options = opts.merge(
    operation: :"LinksApi.update_link",
    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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LinksApi#update_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end