Class: CyberSource::UserManagementSearchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/user_management_search_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ UserManagementSearchApi

Returns a new instance of UserManagementSearchApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/user_management_search_api.rb', line 19

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybersource_rest_client/api/user_management_search_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#search_users(search_request, opts = {}) ⇒ UmsV1UsersGet200Response

Search User Information This endpoint is to get all the user information depending on the filter criteria passed in request body.

Parameters:

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cybersource_rest_client/api/user_management_search_api.rb', line 28

def search_users(search_request, opts = {})
  data, status_code, headers = search_users_with_http_info(search_request, opts)
  return data, status_code, headers
end

#search_users_with_http_info(search_request, opts = {}) ⇒ Array<(UmsV1UsersGet200Response, Fixnum, Hash)>

Search User Information This endpoint is to get all the user information depending on the filter criteria passed in request body.

Parameters:

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

    the optional parameters

Returns:

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

    UmsV1UsersGet200Response data, response status code and response headers



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
 
# File 'lib/cybersource_rest_client/api/user_management_search_api.rb', line 38

def search_users_with_http_info(search_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: UserManagementSearchApi.search_users ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'search_request' is set
  if @api_client.config.client_side_validation && search_request.nil?
    fail ArgumentError, "Missing the required parameter 'search_request' when calling UserManagementSearchApi.search_users"
  end
  # resource path
  local_var_path = 'ums/v1/users/search'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # 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(search_request)
  auth_names = []
  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 => 'UmsV1UsersGet200Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: UserManagementSearchApi#search_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end