Class: TripletexRubyClient::SalarycompilationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SalarycompilationApi 



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

def api_client
  @api_client
end

Instance Method Details

#download_pdf(employee_id, opts = {}) ⇒ String

BETA

Find salary compilation (PDF document) by employee.

Options Hash (opts):

  • :year (Integer) —

    Must be between 1900-2100. Defaults to previous year.



28
29
30
31
 
# File 'lib/tripletex_ruby_client/api/salarycompilation_api.rb', line 28

def download_pdf(employee_id, opts = {})
  data, _status_code, _headers = download_pdf_with_http_info(employee_id, opts)
  data
end

#download_pdf_with_http_info(employee_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

BETA

Find salary compilation (PDF document) by employee.

Options Hash (opts):

  • :year (Integer) —

    Must be between 1900-2100. Defaults to previous year.



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
72
73
74
75
76
77
 
# File 'lib/tripletex_ruby_client/api/salarycompilation_api.rb', line 39

def download_pdf_with_http_info(employee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SalarycompilationApi.download_pdf ...'
  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 SalarycompilationApi.download_pdf"
  end
  # resource path
  local_var_path = '/salary/compilation/pdf'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

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

#get(employee_id, opts = {}) ⇒ ResponseWrapperSalaryCompilation

BETA

Find salary compilation by employee.

Options Hash (opts):

  • :year (Integer) —

    Must be between 1900-2100. Defaults to previous year.

  • :fields (String) —

    Fields filter pattern



85
86
87
88
 
# File 'lib/tripletex_ruby_client/api/salarycompilation_api.rb', line 85

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

#get_with_http_info(employee_id, opts = {}) ⇒ Array<(ResponseWrapperSalaryCompilation, Fixnum, Hash)>

BETA

Find salary compilation by employee.

Options Hash (opts):

  • :year (Integer) —

    Must be between 1900-2100. Defaults to previous year.

  • :fields (String) —

    Fields filter pattern



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
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/tripletex_ruby_client/api/salarycompilation_api.rb', line 97

def get_with_http_info(employee_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SalarycompilationApi.get ...'
  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 SalarycompilationApi.get"
  end
  # resource path
  local_var_path = '/salary/compilation'

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