Class: IntegrationApi::UtilsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/api/utils_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UtilsApi

Returns a new instance of UtilsApi.



19
20
21
 
# File 'lib/integration_api/api/utils_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/integration_api/api/utils_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_token_exchange_using_post(exchange_token_co, opts = {}) ⇒ ExchangePublicTokenVO

Retrieve token based on certain vendor specific value Retrieve the token.

Parameters:

  • exchange_token_co —

    exchangeTokenCO

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/integration_api/api/utils_api.rb', line 27

def create_token_exchange_using_post(exchange_token_co, opts = {})
  data, _status_code, _headers = create_token_exchange_using_post_with_http_info(exchange_token_co, opts)
  data
end

#create_token_exchange_using_post_with_http_info(exchange_token_co, opts = {}) ⇒ Array<(ExchangePublicTokenVO, Fixnum, Hash)>

Retrieve token based on certain vendor specific value Retrieve the token.

Parameters:

  • exchange_token_co —

    exchangeTokenCO

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

    the optional parameters

Returns:

  • (Array<(ExchangePublicTokenVO, Fixnum, Hash)>) —

    ExchangePublicTokenVO data, response status code and response headers



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
 
# File 'lib/integration_api/api/utils_api.rb', line 37

def create_token_exchange_using_post_with_http_info(exchange_token_co, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_token_exchange_using_post ...'
  end
  # verify the required parameter 'exchange_token_co' is set
  if @api_client.config.client_side_validation && exchange_token_co.nil?
    fail ArgumentError, "Missing the required parameter 'exchange_token_co' when calling UtilsApi.create_token_exchange_using_post"
  end
  # resource path
  local_var_path = '/token_exchange'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/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(exchange_token_co)
  auth_names = ['oauth2']
  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 => 'ExchangePublicTokenVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_token_exchange_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_user_using_post(create_user_request, opts = {}) ⇒ UserResponseVO

Create user in vendor Create user in vendor.

Parameters:

  • create_user_request —

    createUserRequest

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/integration_api/api/utils_api.rb', line 81

def create_user_using_post(create_user_request, opts = {})
  data, _status_code, _headers = create_user_using_post_with_http_info(create_user_request, opts)
  data
end

#create_user_using_post_with_http_info(create_user_request, opts = {}) ⇒ Array<(UserResponseVO, Fixnum, Hash)>

Create user in vendor Create user in vendor.

Parameters:

  • create_user_request —

    createUserRequest

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

    the optional parameters

Returns:

  • (Array<(UserResponseVO, Fixnum, Hash)>) —

    UserResponseVO data, response status code and response headers



91
92
93
94
95
96
97
98
99
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
 
# File 'lib/integration_api/api/utils_api.rb', line 91

def create_user_using_post_with_http_info(create_user_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.create_user_using_post ...'
  end
  # verify the required parameter 'create_user_request' is set
  if @api_client.config.client_side_validation && create_user_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_user_request' when calling UtilsApi.create_user_using_post"
  end
  # resource path
  local_var_path = '/user'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/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(create_user_request)
  auth_names = ['oauth2']
  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 => 'UserResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#create_user_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_audit_log_all_using_get(opts = {}) ⇒ Pageobject

Gel all audit log

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :end_date (DateTime) —

    end_date (default to null)

  • :event (String) —

    event

  • :integration_type (String) —

    integration_type

  • :is_request (BOOLEAN) —

    is_request (default to false)

  • :nucleus_client_id (String) —

    nucleus_client_id

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :request_type (String) —

    request_type

  • :size (Integer) —

    size (default to 25)

  • :start_date (DateTime) —

    start_date (default to null)

  • :vendor_name (String) —

    vendor_name

Returns:



145
146
147
148
 
# File 'lib/integration_api/api/utils_api.rb', line 145

def get_audit_log_all_using_get(opts = {})
  data, _status_code, _headers = get_audit_log_all_using_get_with_http_info(opts)
  data
end

#get_audit_log_all_using_get_with_http_info(opts = {}) ⇒ Array<(Pageobject, Fixnum, Hash)>

Gel all audit log

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :end_date (DateTime) —

    end_date

  • :event (String) —

    event

  • :integration_type (String) —

    integration_type

  • :is_request (BOOLEAN) —

    is_request

  • :nucleus_client_id (String) —

    nucleus_client_id

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :request_type (String) —

    request_type

  • :size (Integer) —

    size

  • :start_date (DateTime) —

    start_date

  • :vendor_name (String) —

    vendor_name

Returns:

  • (Array<(Pageobject, Fixnum, Hash)>) —

    Pageobject data, response status code and response headers



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/integration_api/api/utils_api.rb', line 165

def get_audit_log_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_audit_log_all_using_get ...'
  end
  # resource path
  local_var_path = '/audit_log'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
  query_params[:'integration_type'] = opts[:'integration_type'] if !opts[:'integration_type'].nil?
  query_params[:'is_request'] = opts[:'is_request'] if !opts[:'is_request'].nil?
  query_params[:'nucleus_client_id'] = opts[:'nucleus_client_id'] if !opts[:'nucleus_client_id'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'request_type'] = opts[:'request_type'] if !opts[:'request_type'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'vendor_name'] = opts[:'vendor_name'] if !opts[:'vendor_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Pageobject')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_audit_log_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_widget_link_using_get(nucleus_client_id, opts = {}) ⇒ WidgetUrlVO

Retrieve widget link Retrieve the widget link.

Parameters:

  • nucleus_client_id —

    nucleus_client_id

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

    the optional parameters

Options Hash (opts):

  • :is_mobile_webview (BOOLEAN) —

    is_mobile_webview (default to false)

  • :mode (String) —

    mode (default to aggregation)

  • :vendor_name (String) —

    vendor_name

Returns:



218
219
220
221
 
# File 'lib/integration_api/api/utils_api.rb', line 218

def get_widget_link_using_get(nucleus_client_id, opts = {})
  data, _status_code, _headers = get_widget_link_using_get_with_http_info(nucleus_client_id, opts)
  data
end

#get_widget_link_using_get_with_http_info(nucleus_client_id, opts = {}) ⇒ Array<(WidgetUrlVO, Fixnum, Hash)>

Retrieve widget link Retrieve the widget link.

Parameters:

  • nucleus_client_id —

    nucleus_client_id

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

    the optional parameters

Options Hash (opts):

  • :is_mobile_webview (BOOLEAN) —

    is_mobile_webview

  • :mode (String) —

    mode

  • :vendor_name (String) —

    vendor_name

Returns:

  • (Array<(WidgetUrlVO, Fixnum, Hash)>) —

    WidgetUrlVO data, response status code and response headers



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/integration_api/api/utils_api.rb', line 231

def get_widget_link_using_get_with_http_info(nucleus_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilsApi.get_widget_link_using_get ...'
  end
  # verify the required parameter 'nucleus_client_id' is set
  if @api_client.config.client_side_validation && nucleus_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_client_id' when calling UtilsApi.get_widget_link_using_get"
  end
  # resource path
  local_var_path = '/widget_link/{nucleus_client_id}'.sub('{' + 'nucleus_client_id' + '}', nucleus_client_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'is_mobile_webview'] = opts[:'is_mobile_webview'] if !opts[:'is_mobile_webview'].nil?
  query_params[:'mode'] = opts[:'mode'] if !opts[:'mode'].nil?
  query_params[:'vendor_name'] = opts[:'vendor_name'] if !opts[:'vendor_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WidgetUrlVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilsApi#get_widget_link_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end