class Atrium::ConnectWidgetApi
Attributes
Public Class Methods
# File lib/atrium-ruby/api/connect_widget_api.rb, line 15 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Embedding in a website This endpoint will return a URL for an embeddable version of MX Connect. @param user_guid The unique identifier for a `user`. @param body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) @param [Hash] opts the optional parameters @return [ConnectWidgetResponseBody]
# File lib/atrium-ruby/api/connect_widget_api.rb, line 24 def get_connect_widget(user_guid, body, opts = {}) data, _status_code, _headers = get_connect_widget_with_http_info(user_guid, body, opts) data end
Private Instance Methods
Embedding in a website This endpoint will return a URL for an embeddable version of MX Connect. @param user_guid The unique identifier for a `user`. @param body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) @param [Hash] opts the optional parameters @return [Array<(ConnectWidgetResponseBody
, Fixnum, Hash)>] ConnectWidgetResponseBody
data, response status code and response headers
# File lib/atrium-ruby/api/connect_widget_api.rb, line 38 def get_connect_widget_with_http_info(user_guid, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConnectWidgetApi.get_connect_widget ...' end # verify the required parameter 'user_guid' is set if @api_client.config.client_side_validation && user_guid.nil? fail ArgumentError, "Missing the required parameter 'user_guid' when calling ConnectWidgetApi.get_connect_widget" end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling ConnectWidgetApi.get_connect_widget" end # resource path local_var_path = '/users/{user_guid}/connect_widget_url'.sub('{' + 'user_guid' + '}', user_guid.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['apiKey', 'clientID'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectWidgetResponseBody') if @api_client.config.debugging @api_client.config.logger.debug "API called: ConnectWidgetApi#get_connect_widget\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end