Class: TripletexApi::EmployeeemploymentleaveOfAbsenceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/api/employeeemploymentleave_of_absence_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmployeeemploymentleaveOfAbsenceApi

Returns a new instance of EmployeeemploymentleaveOfAbsenceApi.



19
20
21
 
# File 'lib/tripletex_api/api/employeeemploymentleave_of_absence_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_api/api/employeeemploymentleave_of_absence_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(id, opts = {}) ⇒ ResponseWrapperLeaveOfAbsence

BETA

Find leave of absence by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



29
30
31
32
 
# File 'lib/tripletex_api/api/employeeemploymentleave_of_absence_api.rb', line 29

def get(id, opts = {})
  data, _status_code, _headers = get_with_http_info(id, opts)
  return data
end

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperLeaveOfAbsence, Fixnum, Hash)>

BETA

Find leave of absence by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



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/tripletex_api/api/employeeemploymentleave_of_absence_api.rb', line 40

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeemploymentleaveOfAbsenceApi.get ..."
  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 EmployeeemploymentleaveOfAbsenceApi.get"
  end
  # resource path
  local_var_path = "/employee/employment/leaveOfAbsence/{id}".sub('{' + 'id' + '}', id.to_s)

  # 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 => 'ResponseWrapperLeaveOfAbsence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeemploymentleaveOfAbsenceApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(opts = {}) ⇒ ResponseWrapperLeaveOfAbsence

BETA

Create leave of absence.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (LeaveOfAbsence) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



82
83
84
85
 
# File 'lib/tripletex_api/api/employeeemploymentleave_of_absence_api.rb', line 82

def post(opts = {})
  data, _status_code, _headers = post_with_http_info(opts)
  return data
end

#post_list(opts = {}) ⇒ ListResponseLeaveOfAbsence

BETA

Create multiple leave of absences.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<LeaveOfAbsence>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

Returns:



131
132
133
134
 
# File 'lib/tripletex_api/api/employeeemploymentleave_of_absence_api.rb', line 131

def post_list(opts = {})
  data, _status_code, _headers = post_list_with_http_info(opts)
  return data
end

#post_list_with_http_info(opts = {}) ⇒ Array<(ListResponseLeaveOfAbsence, Fixnum, Hash)>

BETA

Create multiple leave of absences.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<LeaveOfAbsence>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

Returns:

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

    ListResponseLeaveOfAbsence data, response status code and response headers



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/tripletex_api/api/employeeemploymentleave_of_absence_api.rb', line 141

def post_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeemploymentleaveOfAbsenceApi.post_list ..."
  end
  # resource path
  local_var_path = "/employee/employment/leaveOfAbsence/list"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

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

#post_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperLeaveOfAbsence, Fixnum, Hash)>

BETA

Create leave of absence.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (LeaveOfAbsence) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



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
 
# File 'lib/tripletex_api/api/employeeemploymentleave_of_absence_api.rb', line 92

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeemploymentleaveOfAbsenceApi.post ..."
  end
  # resource path
  local_var_path = "/employee/employment/leaveOfAbsence"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

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

#put(id, opts = {}) ⇒ ResponseWrapperLeaveOfAbsence

BETA

Update leave of absence.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (LeaveOfAbsence) —

    Partial object describing what should be updated

Returns:



181
182
183
184
 
# File 'lib/tripletex_api/api/employeeemploymentleave_of_absence_api.rb', line 181

def put(id, opts = {})
  data, _status_code, _headers = put_with_http_info(id, opts)
  return data
end

#put_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperLeaveOfAbsence, Fixnum, Hash)>

BETA

Update leave of absence.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (LeaveOfAbsence) —

    Partial object describing what should be updated

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/tripletex_api/api/employeeemploymentleave_of_absence_api.rb', line 192

def put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeemploymentleaveOfAbsenceApi.put ..."
  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 EmployeeemploymentleaveOfAbsenceApi.put"
  end
  # resource path
  local_var_path = "/employee/employment/leaveOfAbsence/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperLeaveOfAbsence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeemploymentleaveOfAbsenceApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end