Class: TripletexRubyClient::SalarysettingsholidayApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SalarysettingsholidayApi

Returns a new instance of SalarysettingsholidayApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_by_ids(ids, opts = {}) ⇒ nil

BETA

delete multiple holiday settings of current logged in company.

Parameters:

  • ids —

    ID of the elements

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_by_ids(ids, opts = {})
  delete_by_ids_with_http_info(ids, opts)
  nil
end

#delete_by_ids_with_http_info(ids, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

BETA

delete multiple holiday settings of current logged in company.

Parameters:

  • ids —

    ID of the elements

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

    the optional parameters

Returns:

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

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

def delete_by_ids_with_http_info(ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SalarysettingsholidayApi.delete_by_ids ...'
  end
  # verify the required parameter 'ids' is set
  if @api_client.config.client_side_validation && ids.nil?
    fail ArgumentError, "Missing the required parameter 'ids' when calling SalarysettingsholidayApi.delete_by_ids"
  end
  # resource path
  local_var_path = '/salary/settings/holiday/list'

  # query parameters
  query_params = {}
  query_params[:'ids'] = ids

  # 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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SalarysettingsholidayApi#delete_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(opts = {}) ⇒ ResponseWrapperCompanyHoliday

BETA

Create a holiday setting of current logged in company.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (CompanyHoliday) —

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

Returns:



77
78
79
80
 
# File 'lib/tripletex_ruby_client/api/salarysettingsholiday_api.rb', line 77

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

#post_list(opts = {}) ⇒ ListResponseCompanyHoliday

BETA

Create multiple holiday settings of current logged in company.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<CompanyHoliday>) —

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

Returns:



125
126
127
128
 
# File 'lib/tripletex_ruby_client/api/salarysettingsholiday_api.rb', line 125

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

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

BETA

Create multiple holiday settings of current logged in company.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<CompanyHoliday>) —

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

Returns:

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

    ListResponseCompanyHoliday data, response status code and response headers



135
136
137
138
139
140
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
 
# File 'lib/tripletex_ruby_client/api/salarysettingsholiday_api.rb', line 135

def post_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SalarysettingsholidayApi.post_list ...'
  end
  # resource path
  local_var_path = '/salary/settings/holiday/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 => 'ListResponseCompanyHoliday')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SalarysettingsholidayApi#post_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

BETA

Create a holiday setting of current logged in company.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (CompanyHoliday) —

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

Returns:



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

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SalarysettingsholidayApi.post ...'
  end
  # resource path
  local_var_path = '/salary/settings/holiday'

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

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

BETA

update a holiday setting of current logged in company.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (CompanyHoliday) —

    Partial object describing what should be updated

Returns:



174
175
176
177
 
# File 'lib/tripletex_ruby_client/api/salarysettingsholiday_api.rb', line 174

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

#put_list(opts = {}) ⇒ ListResponseCompanyHoliday

BETA

update multiple holiday settings of current logged in company.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<CompanyHoliday>) —

    JSON representing updates to object. Should have ID and version set.

Returns:



227
228
229
230
 
# File 'lib/tripletex_ruby_client/api/salarysettingsholiday_api.rb', line 227

def put_list(opts = {})
  data, _status_code, _headers = put_list_with_http_info(opts)
  data
end

#put_list_with_http_info(opts = {}) ⇒ Array<(ListResponseCompanyHoliday, Fixnum, Hash)>

BETA

update multiple holiday settings of current logged in company.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<CompanyHoliday>) —

    JSON representing updates to object. Should have ID and version set.

Returns:

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

    ListResponseCompanyHoliday data, response status code and response headers



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

def put_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SalarysettingsholidayApi.put_list ...'
  end
  # resource path
  local_var_path = '/salary/settings/holiday/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(: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 => 'ListResponseCompanyHoliday')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SalarysettingsholidayApi#put_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

BETA

update a holiday setting of current logged in company.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (CompanyHoliday) —

    Partial object describing what should be updated

Returns:



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
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/tripletex_ruby_client/api/salarysettingsholiday_api.rb', line 185

def put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SalarysettingsholidayApi.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 SalarysettingsholidayApi.put"
  end
  # resource path
  local_var_path = '/salary/settings/holiday/{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 => 'ResponseWrapperCompanyHoliday')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SalarysettingsholidayApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseCompanyHoliday

BETA

Find holiday settings of current logged in company.

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:



278
279
280
281
 
# File 'lib/tripletex_ruby_client/api/salarysettingsholiday_api.rb', line 278

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

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

BETA

Find holiday settings of current logged in company.

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<(ListResponseCompanyHoliday, Fixnum, Hash)>) —

    ListResponseCompanyHoliday data, response status code and response headers



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/tripletex_ruby_client/api/salarysettingsholiday_api.rb', line 291

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SalarysettingsholidayApi.search ...'
  end
  # resource path
  local_var_path = '/salary/settings/holiday'

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