Class: TripletexRubyClient::EmployeepreferencesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/employeepreferences_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmployeepreferencesApi

Returns a new instance of EmployeepreferencesApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/employeepreferences_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/tripletex_ruby_client/api/employeepreferences_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#logged_in_employee_preferences(opts = {}) ⇒ ResponseWrapperEmployeePreferences

BETA

Get employee preferences for current user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



27
28
29
30
 
# File 'lib/tripletex_ruby_client/api/employeepreferences_api.rb', line 27

def logged_in_employee_preferences(opts = {})
  data, _status_code, _headers = logged_in_employee_preferences_with_http_info(opts)
  data
end

#logged_in_employee_preferences_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperEmployeePreferences, Fixnum, Hash)>

BETA

Get employee preferences for current user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



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

def logged_in_employee_preferences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeepreferencesApi.logged_in_employee_preferences ...'
  end
  # resource path
  local_var_path = '/employee/preferences/>loggedInEmployeePreferences'

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperEmployeePreferences')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeepreferencesApi#logged_in_employee_preferences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ResponseWrapperEmployeePreferences

BETA

Find employee category corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Equals

  • :employee_id (Integer) —

    Equals

  • :fields (String) —

    Fields filter pattern

Returns:



76
77
78
79
 
# File 'lib/tripletex_ruby_client/api/employeepreferences_api.rb', line 76

def search(opts = {})
  data, _status_code, _headers = search_with_http_info(opts)
  data
end

#search_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperEmployeePreferences, Fixnum, Hash)>

BETA

Find employee category corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Equals

  • :employee_id (Integer) —

    Equals

  • :fields (String) —

    Fields filter pattern

Returns:



88
89
90
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
 
# File 'lib/tripletex_ruby_client/api/employeepreferences_api.rb', line 88

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeepreferencesApi.search ...'
  end
  # resource path
  local_var_path = '/employee/preferences'

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperEmployeePreferences')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeepreferencesApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end