Class: TripletexRubyClient::ResultbudgetApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResultbudgetApi

Returns a new instance of ResultbudgetApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_company_result_budget(opts = {}) ⇒ ListResponseResultBudget

Get result budget for company

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

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



31
32
33
34
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 31

def get_company_result_budget(opts = {})
  data, _status_code, _headers = get_company_result_budget_with_http_info(opts)
  data
end

#get_company_result_budget_with_http_info(opts = {}) ⇒ Array<(ListResponseResultBudget, Fixnum, Hash)>

Get result budget for company

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseResultBudget data, response status code and response headers



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
78
79
80
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 45

def get_company_result_budget_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResultbudgetApi.get_company_result_budget ...'
  end
  # resource path
  local_var_path = '/resultbudget/company'

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

#get_department_result_budget(id, opts = {}) ⇒ ListResponseResultBudget

Get result budget associated with a departmentId

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

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



91
92
93
94
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 91

def get_department_result_budget(id, opts = {})
  data, _status_code, _headers = get_department_result_budget_with_http_info(id, opts)
  data
end

#get_department_result_budget_with_http_info(id, opts = {}) ⇒ Array<(ListResponseResultBudget, Fixnum, Hash)>

Get result budget associated with a departmentId

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseResultBudget data, response status code and response headers



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
139
140
141
142
143
144
145
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 106

def get_department_result_budget_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResultbudgetApi.get_department_result_budget ...'
  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 ResultbudgetApi.get_department_result_budget"
  end
  # resource path
  local_var_path = '/resultbudget/department/{id}'.sub('{' + 'id' + '}', id.to_s)

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

#get_employee_result_budget(id, opts = {}) ⇒ ListResponseResultBudget

Get result budget associated with an employeeId

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

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



156
157
158
159
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 156

def get_employee_result_budget(id, opts = {})
  data, _status_code, _headers = get_employee_result_budget_with_http_info(id, opts)
  data
end

#get_employee_result_budget_with_http_info(id, opts = {}) ⇒ Array<(ListResponseResultBudget, Fixnum, Hash)>

Get result budget associated with an employeeId

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseResultBudget data, response status code and response headers



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_ruby_client/api/resultbudget_api.rb', line 171

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

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

#get_product_result_budget(id, opts = {}) ⇒ ListResponseResultBudget

Get result budget associated with a productId

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

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



221
222
223
224
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 221

def get_product_result_budget(id, opts = {})
  data, _status_code, _headers = get_product_result_budget_with_http_info(id, opts)
  data
end

#get_product_result_budget_with_http_info(id, opts = {}) ⇒ Array<(ListResponseResultBudget, Fixnum, Hash)>

Get result budget associated with a productId

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseResultBudget data, response status code and response headers



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
273
274
275
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 236

def get_product_result_budget_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResultbudgetApi.get_product_result_budget ...'
  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 ResultbudgetApi.get_product_result_budget"
  end
  # resource path
  local_var_path = '/resultbudget/product/{id}'.sub('{' + 'id' + '}', id.to_s)

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

#get_project_result_budget(id, opts = {}) ⇒ ListResponseResultBudget

Get result budget associated with a projectId

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

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



286
287
288
289
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 286

def get_project_result_budget(id, opts = {})
  data, _status_code, _headers = get_project_result_budget_with_http_info(id, opts)
  data
end

#get_project_result_budget_with_http_info(id, opts = {}) ⇒ Array<(ListResponseResultBudget, Fixnum, Hash)>

Get result budget associated with a projectId

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

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

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseResultBudget data, response status code and response headers



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
333
334
335
336
337
338
339
340
 
# File 'lib/tripletex_ruby_client/api/resultbudget_api.rb', line 301

def get_project_result_budget_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResultbudgetApi.get_project_result_budget ...'
  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 ResultbudgetApi.get_project_result_budget"
  end
  # resource path
  local_var_path = '/resultbudget/project/{id}'.sub('{' + 'id' + '}', id.to_s)

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