Class: MoneyKit::LinkSessionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LinkSessionApi 



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

def api_client
  @api_client
end

Instance Method Details

/link-session This endpoint is to be called by your back end, to establish a new link session for creating a link to your end user’s institution.



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

def create_link_session(create_link_session_request, opts = {})
  data, _status_code, _headers = create_link_session_with_http_info(create_link_session_request, opts)
  data
end

#create_link_session_with_http_info(create_link_session_request, opts = {}) ⇒ Array<(CreateLinkSessionResponse, Integer, Hash)>

/link-session This endpoint is to be called by your back end, to establish a new link session for creating a link to your end user&#39;s institution.



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
84
85
86
87
88
 
# File 'lib/moneykit/api/link_session_api.rb', line 37

def create_link_session_with_http_info(create_link_session_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinkSessionApi.create_link_session ...'
  end
  # verify the required parameter 'create_link_session_request' is set
  if @api_client.config.client_side_validation && create_link_session_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_link_session_request' when calling LinkSessionApi.create_link_session"
  end
  # resource path
  local_var_path = '/link-session'

  # 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(create_link_session_request)

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

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

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

#exchange_token(exchange_token_request, opts = {}) ⇒ ExchangeTokenResponse

/link-session/exchange-token After the end user has successfully completed the linking process, your back end calls this endpoint to exchange the token received by your front end for a`link_id` that can be used to access the link’s data.



95
96
97
98
 
# File 'lib/moneykit/api/link_session_api.rb', line 95

def exchange_token(exchange_token_request, opts = {})
  data, _status_code, _headers = exchange_token_with_http_info(exchange_token_request, opts)
  data
end

#exchange_token_with_http_info(exchange_token_request, opts = {}) ⇒ Array<(ExchangeTokenResponse, Integer, Hash)>

/link-session/exchange-token After the end user has successfully completed the linking process, your back end calls this endpoint to exchange the token received by your front end for a&#x60;link_id&#x60; that can be used to access the link&#39;s data.



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
150
151
152
153
154
155
156
 
# File 'lib/moneykit/api/link_session_api.rb', line 105

def exchange_token_with_http_info(exchange_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LinkSessionApi.exchange_token ...'
  end
  # verify the required parameter 'exchange_token_request' is set
  if @api_client.config.client_side_validation && exchange_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'exchange_token_request' when calling LinkSessionApi.exchange_token"
  end
  # resource path
  local_var_path = '/link-session/exchange-token'

  # 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(exchange_token_request)

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

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

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