Class: MoneyKit::LinksApi
- Inherits:
-
Object
- Object
- MoneyKit::LinksApi
- Defined in:
- lib/moneykit/api/links_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#disconnect(id, opts = {}) ⇒ nil
/links/id Deletes this link and disables its access token.
-
#disconnect_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
/links/id Deletes this link and disables its access token.
-
#get_link(id, opts = {}) ⇒ LinkResponse
/links/id Fetches details about a link.
-
#get_link_with_http_info(id, opts = {}) ⇒ Array<(LinkResponse, Integer, Hash)>
/links/id Fetches details about a link.
-
#get_user_links(id, opts = {}) ⇒ GetUserLinksResponse
/users/id/links Fetches all links belonging to a <a href=#operation/get_user_accounts>user</a>.
-
#get_user_links_with_http_info(id, opts = {}) ⇒ Array<(GetUserLinksResponse, Integer, Hash)>
/users/id/links Fetches all links belonging to a <a href=#operation/get_user_accounts>user</a>.
-
#initialize(api_client = ApiClient.default) ⇒ LinksApi
constructor
A new instance of LinksApi.
-
#reset_login(id, opts = {}) ⇒ LinkResponse
Force a "relink required" state on a link (Test only).
-
#reset_login_with_http_info(id, opts = {}) ⇒ Array<(LinkResponse, Integer, Hash)>
Force a "relink required" state on a link (Test only).
-
#update_link(id, update_link_request, opts = {}) ⇒ LinkResponse
/links/id Updates the link configuration.
-
#update_link_with_http_info(id, update_link_request, opts = {}) ⇒ Array<(LinkResponse, Integer, Hash)>
/links/id Updates the link configuration.
Constructor Details
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
#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.
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. <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.
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 disconnect_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LinksApi.disconnect ...' 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.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']) # 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'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: LinksApi#disconnect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_link(id, opts = {}) ⇒ LinkResponse
/links/id Fetches details about a link.
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<(LinkResponse, Integer, Hash)>
/links/id Fetches details about a link.
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] || 'LinkResponse' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials'] = 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, ) 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>.
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 <a href=#operation/get_user_accounts>user</a>.
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'] = 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, ) 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 |
#reset_login(id, opts = {}) ⇒ LinkResponse
Force a "relink required" state on a link (Test only).
215 216 217 218 |
# File 'lib/moneykit/api/links_api.rb', line 215 def reset_login(id, opts = {}) data, _status_code, _headers = reset_login_with_http_info(id, opts) data end |
#reset_login_with_http_info(id, opts = {}) ⇒ Array<(LinkResponse, Integer, Hash)>
Force a "relink required" state on a link (Test only).
224 225 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 |
# File 'lib/moneykit/api/links_api.rb', line 224 def reset_login_with_http_info(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] || 'LinkResponse' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials'] = 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, ) 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 = {}) ⇒ LinkResponse
/links/id Updates the link configuration.
278 279 280 281 |
# File 'lib/moneykit/api/links_api.rb', line 278 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.
289 290 291 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 339 340 341 342 343 344 |
# File 'lib/moneykit/api/links_api.rb', line 289 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] || 'LinkResponse' # auth_names auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials'] = 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, ) 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 |