Class: MoneyKit::IdentityApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IdentityApi

Returns a new instance of IdentityApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_identities(id, opts = {}) ⇒ IdentityResponse

/links/id/identity Returns account owner information from the institution, including names, emails, phone numbers, and addresses, for all permissioned accounts associated with a <a href=#tag/Links>link</a>. This information will appear in the ‘owners` list in the `accounts` object. <p>Some fields may be empty, if not provided by the institution. <p>Note that this endpoint does not trigger a fetch of owner information from the institution; it merely returns owner information that has already been fetched, either because `prefetch` was requested when the link was created, or because of an on-demand update. **To force a check for new/updated owner information, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :account_ids (Array<String>) —

    An optional list of account IDs to filter the results.

Returns:



28
29
30
31
 
# File 'lib/moneykit/api/identity_api.rb', line 28

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

#get_identities_with_http_info(id, opts = {}) ⇒ Array<(IdentityResponse, Integer, Hash)>

/links/id/identity Returns account owner information from the institution, including names, emails, phone numbers, and addresses, for all permissioned accounts associated with a &lt;a href&#x3D;#tag/Links&gt;link&lt;/a&gt;. This information will appear in the &#x60;owners&#x60; list in the &#x60;accounts&#x60; object. &lt;p&gt;Some fields may be empty, if not provided by the institution. &lt;p&gt;Note that this endpoint does not trigger a fetch of owner information from the institution; it merely returns owner information that has already been fetched, either because &#x60;prefetch&#x60; was requested when the link was created, or because of an on-demand update. **To force a check for new/updated owner information, you must use the &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.** &lt;p&gt;If you have requested prefetch or an on-demand update, you should check the &#x60;refreshed_at&#x60; date for this product in the returned response, and compare that against the previous &#x60;refreshed_at&#x60; date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :account_ids (Array<String>) —

    An optional list of account IDs to filter the results.

Returns:

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

    IdentityResponse 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
80
81
82
83
84
85
86
 
# File 'lib/moneykit/api/identity_api.rb', line 39

def get_identities_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IdentityApi.get_identities ...'
  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 IdentityApi.get_identities"
  end
  # resource path
  local_var_path = '/links/{id}/identity'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?

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

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

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