Class: TripletexApi::EmployeeentitlementApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmployeeentitlementApi

Returns a new instance of EmployeeentitlementApi.



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

def api_client
  @api_client
end

Instance Method Details

#client(opts = {}) ⇒ ListResponseEntitlement

BETA

Find all entitlements at client for user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :customer_id (Integer) —

    Client ID

  • :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:



33
34
35
36
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 33

def client(opts = {})
  data, _status_code, _headers = client_with_http_info(opts)
  return data
end

#client_with_http_info(opts = {}) ⇒ Array<(ListResponseEntitlement, Fixnum, Hash)>

BETA

Find all entitlements at client for user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :customer_id (Integer) —

    Client ID

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEntitlement data, response status code and response headers



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

def client_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeentitlementApi.client ..."
  end
  # resource path
  local_var_path = "/employee/entitlement/client"

  # query parameters
  query_params = {}
  query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
  query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
  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 => 'ListResponseEntitlement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeentitlementApi#client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get entitlement by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



92
93
94
95
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 92

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

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

Get entitlement by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperEntitlement data, response status code and response headers



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
134
135
136
137
138
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 103

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeentitlementApi.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 EmployeeentitlementApi.get"
  end
  # resource path
  local_var_path = "/employee/entitlement/{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 => 'ResponseWrapperEntitlement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmployeeentitlementApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#grant_client_entitlements_by_template(employee_id, customer_id, template, opts = {}) ⇒ nil

BETA

Update employee entitlements in client account.

Parameters:

  • employee_id —

    Employee ID

  • customer_id —

    Client ID

  • template —

    Template

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

    the optional parameters

Options Hash (opts):

  • :add_to_existing (BOOLEAN) —

    Add template to existing entitlements (default to false)

Returns:

  • (nil) 


148
149
150
151
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 148

def grant_client_entitlements_by_template(employee_id, customer_id, template, opts = {})
  grant_client_entitlements_by_template_with_http_info(employee_id, customer_id, template, opts)
  return nil
end

#grant_client_entitlements_by_template_with_http_info(employee_id, customer_id, template, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

BETA

Update employee entitlements in client account.

Parameters:

  • employee_id —

    Employee ID

  • customer_id —

    Client ID

  • template —

    Template

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

    the optional parameters

Options Hash (opts):

  • :add_to_existing (BOOLEAN) —

    Add template to existing entitlements

Returns:

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

    nil, response status code and response headers



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
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 161

def grant_client_entitlements_by_template_with_http_info(employee_id, customer_id, template, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeentitlementApi.grant_client_entitlements_by_template ..."
  end
  # verify the required parameter 'employee_id' is set
  if @api_client.config.client_side_validation && employee_id.nil?
    fail ArgumentError, "Missing the required parameter 'employee_id' when calling EmployeeentitlementApi.grant_client_entitlements_by_template"
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling EmployeeentitlementApi.grant_client_entitlements_by_template"
  end
  # verify the required parameter 'template' is set
  if @api_client.config.client_side_validation && template.nil?
    fail ArgumentError, "Missing the required parameter 'template' when calling EmployeeentitlementApi.grant_client_entitlements_by_template"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['NONE_PRIVILEGES', 'STANDARD_PRIVILEGES_ACCOUNTANT', 'STANDARD_PRIVILEGES_AUDITOR', 'ALL_PRIVILEGES', 'AGRO_READ_ONLY', 'AGRO_READ_APPROVE', 'AGRO_READ_WRITE', 'AGRO_READ_WRITE_APPROVE'].include?(template)
    fail ArgumentError, "invalid value for 'template', must be one of NONE_PRIVILEGES, STANDARD_PRIVILEGES_ACCOUNTANT, STANDARD_PRIVILEGES_AUDITOR, ALL_PRIVILEGES, AGRO_READ_ONLY, AGRO_READ_APPROVE, AGRO_READ_WRITE, AGRO_READ_WRITE_APPROVE"
  end
  # resource path
  local_var_path = "/employee/entitlement/:grantClientEntitlementsByTemplate"

  # query parameters
  query_params = {}
  query_params[:'employeeId'] = employee_id
  query_params[:'customerId'] = customer_id
  query_params[:'template'] = template
  query_params[:'addToExisting'] = opts[:'add_to_existing'] if !opts[:'add_to_existing'].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(:PUT, 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: EmployeeentitlementApi#grant_client_entitlements_by_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#grant_entitlements_by_template(employee_id, template, opts = {}) ⇒ nil

BETA

Update employee entitlements.

The user will only receive the entitlements which are possible with the registered user type

Parameters:

  • employee_id —

    Employee ID

  • template —

    Template

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

    the optional parameters

Returns:

  • (nil) 


218
219
220
221
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 218

def grant_entitlements_by_template(employee_id, template, opts = {})
  grant_entitlements_by_template_with_http_info(employee_id, template, opts)
  return nil
end

#grant_entitlements_by_template_with_http_info(employee_id, template, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

BETA

Update employee entitlements.

The user will only receive the entitlements which are possible with the registered user type

Parameters:

  • employee_id —

    Employee ID

  • template —

    Template

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 229

def grant_entitlements_by_template_with_http_info(employee_id, template, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmployeeentitlementApi.grant_entitlements_by_template ..."
  end
  # verify the required parameter 'employee_id' is set
  if @api_client.config.client_side_validation && employee_id.nil?
    fail ArgumentError, "Missing the required parameter 'employee_id' when calling EmployeeentitlementApi.grant_entitlements_by_template"
  end
  # verify the required parameter 'template' is set
  if @api_client.config.client_side_validation && template.nil?
    fail ArgumentError, "Missing the required parameter 'template' when calling EmployeeentitlementApi.grant_entitlements_by_template"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['NONE_PRIVILEGES', 'ALL_PRIVILEGES', 'INVOICING_MANAGER', 'PERSONELL_MANAGER', 'ACCOUNTANT', 'AUDITOR', 'DEPARTMENT_LEADER'].include?(template)
    fail ArgumentError, "invalid value for 'template', must be one of NONE_PRIVILEGES, ALL_PRIVILEGES, INVOICING_MANAGER, PERSONELL_MANAGER, ACCOUNTANT, AUDITOR, DEPARTMENT_LEADER"
  end
  # resource path
  local_var_path = "/employee/entitlement/:grantEntitlementsByTemplate"

  # query parameters
  query_params = {}
  query_params[:'employeeId'] = employee_id
  query_params[:'template'] = template

  # 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(:PUT, 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: EmployeeentitlementApi#grant_entitlements_by_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseEntitlement

Find all entitlements for user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :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:



283
284
285
286
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 283

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

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

Find all entitlements for user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :employee_id (Integer) —

    Employee ID. Defaults to ID of token owner.

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseEntitlement data, response status code and response headers



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
326
327
328
329
330
331
332
 
# File 'lib/tripletex_api/api/employeeentitlement_api.rb', line 297

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

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