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

Returns a new instance of LinksApi.



19
20
21
 
# File 'lib/moneykit/api/links_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/moneykit/api/links_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

/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.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_link(id, opts = {})
  delete_link_with_http_info(id, opts)
  nil
end

#delete_link_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.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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

def delete_link_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinksApi.delete_link ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling LinksApi.delete_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'])

  # 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.delete_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LinksApi#delete_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

/links/id Fetches details about a link.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/moneykit/api/links_api.rb', line 90

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<(LinkCommon, Integer, Hash)>

/links/id Fetches details about a link.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:

  • (Array<(LinkCommon, Integer, Hash)>) —

    LinkCommon data, response status code and response headers



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
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/moneykit/api/links_api.rb', line 100

def get_link_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinksApi.get_link ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail 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'])

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

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

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

  # 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
  return 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>.

Parameters:

  • id (String) —

    The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;/api/operation/create_link_session#customer_user-id&gt;link-session&lt;/a&gt; to create any link for this user.

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

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/moneykit/api/links_api.rb', line 153

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;.

Parameters:

  • id (String) —

    The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;/api/operation/create_link_session#customer_user-id&gt;link-session&lt;/a&gt; to create any link for this user.

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

    the optional parameters

Returns:

  • (Array<(GetUserLinksResponse, Integer, Hash)>) —

    GetUserLinksResponse data, response status code and response headers



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/moneykit/api/links_api.rb', line 163

def get_user_links_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinksApi.get_user_links ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail 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'])

  # 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
  return data, status_code, headers
end

#import_link(import_link_request, opts = {}) ⇒ LinkCommon

/links/import Creates a new link with pre-populated accounts and transactions. The new link will be created in an initially ‘disconnected` state, with an error code of `auth_expired`, but all data will be available. As with any disconnected link, the imported link can then be reconnected at any time by starting a new <a href=#operation/create_link_session>/link-session</a> with `existing_link_id` set to the link’s ‘link_id`. Note that the link can be reconnected using any suitable provider. <p> The imported data has a maximum size limit of 1MB, which corresponds very roughly to about 4000 transactions. The data is processed synchronously, so you can expect a delay of up to 10 seconds before the response is transmitted. You should set generous HTTP read timeouts to avoid disconnecting before the import is complete.

Parameters:

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

    the optional parameters

Returns:



216
217
218
219
 
# File 'lib/moneykit/api/links_api.rb', line 216

def import_link(import_link_request, opts = {})
  data, _status_code, _headers = import_link_with_http_info(import_link_request, opts)
  data
end

#import_link_with_http_info(import_link_request, opts = {}) ⇒ Array<(LinkCommon, Integer, Hash)>

/links/import Creates a new link with pre-populated accounts and transactions. The new link will be created in an initially &#x60;disconnected&#x60; state, with an error code of &#x60;auth_expired&#x60;, but all data will be available. As with any disconnected link, the imported link can then be reconnected at any time by starting a new &lt;a href&#x3D;#operation/create_link_session&gt;/link-session&lt;/a&gt; with &#x60;existing_link_id&#x60; set to the link&#39;s &#x60;link_id&#x60;. Note that the link can be reconnected using any suitable provider. &lt;p&gt; The imported data has a maximum size limit of 1MB, which corresponds very roughly to about 4000 transactions. The data is processed synchronously, so you can expect a delay of up to 10 seconds before the response is transmitted. You should set generous HTTP read timeouts to avoid disconnecting before the import is complete.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(LinkCommon, Integer, Hash)>) —

    LinkCommon data, response status code and response headers



226
227
228
229
230
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 226

def import_link_with_http_info(import_link_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinksApi.import_link ...'
  end
  # verify the required parameter 'import_link_request' is set
  if @api_client.config.client_side_validation && import_link_request.nil?
    fail ArgumentError, "Missing the required parameter 'import_link_request' when calling LinksApi.import_link"
  end
  # resource path
  local_var_path = '/links/import'

  # 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'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

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

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

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

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

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

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:



283
284
285
286
 
# File 'lib/moneykit/api/links_api.rb', line 283

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

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

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

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:

  • (Array<(LinkCommon, Integer, Hash)>) —

    LinkCommon data, response status code and response headers



292
293
294
295
296
297
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
 
# File 'lib/moneykit/api/links_api.rb', line 292

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinksApi.reset_login ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail 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'])

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

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

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

  # 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
  return data, status_code, headers
end

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

/links/id Updates the link configuration.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:



346
347
348
349
 
# File 'lib/moneykit/api/links_api.rb', line 346

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<(LinkCommon, Integer, Hash)>

/links/id Updates the link configuration.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Returns:

  • (Array<(LinkCommon, Integer, Hash)>) —

    LinkCommon data, response status code and response headers



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/moneykit/api/links_api.rb', line 357

def update_link_with_http_info(id, update_link_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinksApi.update_link ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail 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?
    fail 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'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # 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] || 'LinkCommon'

  # 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
  return data, status_code, headers
end