Class: MoneyKit::InstitutionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InstitutionsApi

Returns a new instance of InstitutionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_institution(institution_id, opts = {}) ⇒ Institution

/institutions/institution_id Fetches details about a single institution.

Parameters:

  • institution_id (String) —

    The institution ID to fetch.

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

    the optional parameters

Options Hash (opts):

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

Returns:



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

def get_institution(institution_id, opts = {})
  data, _status_code, _headers = get_institution_with_http_info(institution_id, opts)
  data
end

#get_institution_with_http_info(institution_id, opts = {}) ⇒ Array<(Institution, Integer, Hash)>

/institutions/institution_id Fetches details about a single institution.

Parameters:

  • institution_id (String) —

    The institution ID to fetch.

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    Institution 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/institutions_api.rb', line 39

def get_institution_with_http_info(institution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstitutionsApi.get_institution ...'
  end
  # verify the required parameter 'institution_id' is set
  if @api_client.config.client_side_validation && institution_id.nil?
    fail ArgumentError, "Missing the required parameter 'institution_id' when calling InstitutionsApi.get_institution"
  end
  # resource path
  local_var_path = '/institutions/{institution_id}'.sub('{' + 'institution_id' + '}', CGI.escape(institution_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'] if !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] || 'Institution'

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

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

#get_institutions(opts = {}) ⇒ GetInstitutionsResponse

/institutions Fetches a list of institutions, optionally filtered by name. Results are paginated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    If provided, returns only institutions containing this name (wholly or as a prefix).

  • :featured (Boolean) —

    If true, returns only featured institutions. (default to false)

  • :cursor (String) —

    Cursor to fetch the next set of institutions. (You get this value from the previous call to &#x60;/institutions&#x60;.)

  • :limit (Integer) —

    A limit on the number of institutions to be returned. (default to 50)

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

Returns:



97
98
99
100
 
# File 'lib/moneykit/api/institutions_api.rb', line 97

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

#get_institutions_with_http_info(opts = {}) ⇒ Array<(GetInstitutionsResponse, Integer, Hash)>

/institutions Fetches a list of institutions, optionally filtered by name. Results are paginated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    If provided, returns only institutions containing this name (wholly or as a prefix).

  • :featured (Boolean) —

    If true, returns only featured institutions. (default to false)

  • :cursor (String) —

    Cursor to fetch the next set of institutions. (You get this value from the previous call to &#x60;/institutions&#x60;.)

  • :limit (Integer) —

    A limit on the number of institutions to be returned. (default to 50)

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

Returns:

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

    GetInstitutionsResponse data, response status code and response headers



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/moneykit/api/institutions_api.rb', line 111

def get_institutions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstitutionsApi.get_institutions ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InstitutionsApi.get_institutions, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InstitutionsApi.get_institutions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/institutions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'featured'] = opts[:'featured'] if !opts[:'featured'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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'] if !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] || 'GetInstitutionsResponse'

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

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