Class: TripletexRubyClient::EmployeeemploymentemploymentTypeApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmployeeemploymentemploymentTypeApi

Returns a new instance of EmployeeemploymentemploymentTypeApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_employment_end_reason_type(opts = {}) ⇒ ListResponseEmploymentType

BETA

Find all employment end reason type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



30
31
32
33
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 30

def get_employment_end_reason_type(opts = {})
  data, _status_code, _headers = get_employment_end_reason_type_with_http_info(opts)
  data
end

#get_employment_end_reason_type_with_http_info(opts = {}) ⇒ Array<(ListResponseEmploymentType, Fixnum, Hash)>

BETA

Find all employment end reason type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEmploymentType data, response status code and response headers



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

def get_employment_end_reason_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeeemploymentemploymentTypeApi.get_employment_end_reason_type ...'
  end
  # resource path
  local_var_path = '/employee/employment/employmentType/employmentEndReasonType'

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].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 => 'ListResponseEmploymentType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeemploymentemploymentTypeApi#get_employment_end_reason_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_employment_form_type(opts = {}) ⇒ ListResponseEmploymentType

BETA

Find all employment form type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



86
87
88
89
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 86

def get_employment_form_type(opts = {})
  data, _status_code, _headers = get_employment_form_type_with_http_info(opts)
  data
end

#get_employment_form_type_with_http_info(opts = {}) ⇒ Array<(ListResponseEmploymentType, Fixnum, Hash)>

BETA

Find all employment form type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEmploymentType data, response status code and response headers



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
130
131
132
133
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 99

def get_employment_form_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeeemploymentemploymentTypeApi.get_employment_form_type ...'
  end
  # resource path
  local_var_path = '/employee/employment/employmentType/employmentFormType'

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].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 => 'ListResponseEmploymentType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeemploymentemploymentTypeApi#get_employment_form_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_maritime_employment_type(type, opts = {}) ⇒ ListResponseEmploymentType

BETA

Find all maritime employment type IDs.

Parameters:

  • type —

    maritimeEmploymentType

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



143
144
145
146
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 143

def get_maritime_employment_type(type, opts = {})
  data, _status_code, _headers = get_maritime_employment_type_with_http_info(type, opts)
  data
end

#get_maritime_employment_type_with_http_info(type, opts = {}) ⇒ Array<(ListResponseEmploymentType, Fixnum, Hash)>

BETA

Find all maritime employment type IDs.

Parameters:

  • type —

    maritimeEmploymentType

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEmploymentType data, response status code and response headers



157
158
159
160
161
162
163
164
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
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 157

def get_maritime_employment_type_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeeemploymentemploymentTypeApi.get_maritime_employment_type ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling EmployeeemploymentemploymentTypeApi.get_maritime_employment_type"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['SHIP_REGISTER', 'SHIP_TYPE', 'TRADE_AREA'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of SHIP_REGISTER, SHIP_TYPE, TRADE_AREA"
  end
  # resource path
  local_var_path = '/employee/employment/employmentType/maritimeEmploymentType'

  # query parameters
  query_params = {}
  query_params[:'type'] = type
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].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 => 'ListResponseEmploymentType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeemploymentemploymentTypeApi#get_maritime_employment_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_salary_type(opts = {}) ⇒ ListResponseEmploymentType

BETA

Find all salary type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



209
210
211
212
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 209

def get_salary_type(opts = {})
  data, _status_code, _headers = get_salary_type_with_http_info(opts)
  data
end

#get_salary_type_with_http_info(opts = {}) ⇒ Array<(ListResponseEmploymentType, Fixnum, Hash)>

BETA

Find all salary type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEmploymentType data, response status code and response headers



222
223
224
225
226
227
228
229
230
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
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 222

def get_salary_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeeemploymentemploymentTypeApi.get_salary_type ...'
  end
  # resource path
  local_var_path = '/employee/employment/employmentType/salaryType'

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].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 => 'ListResponseEmploymentType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeemploymentemploymentTypeApi#get_salary_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schedule_type(opts = {}) ⇒ ListResponseEmploymentType

BETA

Find all schedule type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



265
266
267
268
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 265

def get_schedule_type(opts = {})
  data, _status_code, _headers = get_schedule_type_with_http_info(opts)
  data
end

#get_schedule_type_with_http_info(opts = {}) ⇒ Array<(ListResponseEmploymentType, Fixnum, Hash)>

BETA

Find all schedule type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEmploymentType data, response status code and response headers



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 278

def get_schedule_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmployeeemploymentemploymentTypeApi.get_schedule_type ...'
  end
  # resource path
  local_var_path = '/employee/employment/employmentType/scheduleType'

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].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 => 'ListResponseEmploymentType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeemploymentemploymentTypeApi#get_schedule_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseEmploymentType

BETA

Find all employment type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



321
322
323
324
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 321

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

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

BETA

Find all employment type IDs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEmploymentType data, response status code and response headers



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/tripletex_ruby_client/api/employeeemploymentemployment_type_api.rb', line 334

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

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].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 => 'ListResponseEmploymentType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeemploymentemploymentTypeApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end