Class: TripletexApi::TravelExpensemileageAllowanceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TravelExpensemileageAllowanceApi

Returns a new instance of TravelExpensemileageAllowanceApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete(id, opts = {}) ⇒ nil

BETA

Delete mileage allowance.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/tripletex_api/api/travel_expensemileage_allowance_api.rb', line 28

def delete(id, opts = {})
  delete_with_http_info(id, opts)
  return nil
end

#delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

BETA

Delete mileage allowance.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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_api/api/travel_expensemileage_allowance_api.rb', line 38

def delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TravelExpensemileageAllowanceApi.delete ..."
  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 TravelExpensemileageAllowanceApi.delete"
  end
  # resource path
  local_var_path = "/travelExpense/mileageAllowance/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

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

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

BETA

Get mileage allowance by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



79
80
81
82
 
# File 'lib/tripletex_api/api/travel_expensemileage_allowance_api.rb', line 79

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

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

BETA

Get mileage allowance by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



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
120
121
122
123
124
125
 
# File 'lib/tripletex_api/api/travel_expensemileage_allowance_api.rb', line 90

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

#post(opts = {}) ⇒ ResponseWrapperMileageAllowance

BETA

Create mileage allowance.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (MileageAllowance) —

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

Returns:



132
133
134
135
 
# File 'lib/tripletex_api/api/travel_expensemileage_allowance_api.rb', line 132

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

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

BETA

Create mileage allowance.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (MileageAllowance) —

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

Returns:



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
168
169
170
171
172
173
174
 
# File 'lib/tripletex_api/api/travel_expensemileage_allowance_api.rb', line 142

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TravelExpensemileageAllowanceApi.post ..."
  end
  # resource path
  local_var_path = "/travelExpense/mileageAllowance"

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

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

BETA

Update mileage allowance.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

Returns:



182
183
184
185
 
# File 'lib/tripletex_api/api/travel_expensemileage_allowance_api.rb', line 182

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

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

BETA

Update mileage allowance.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

Returns:



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

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

#search(opts = {}) ⇒ ListResponseMileageAllowance

BETA

Find mileage allowances corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :travel_expense_id (String) —

    Equals

  • :rate_type_id (String) —

    Equals

  • :rate_category_id (String) —

    Equals

  • :km_from (Float) —

    From and including

  • :km_to (Float) —

    To and excluding

  • :rate_from (Float) —

    From and including

  • :rate_to (Float) —

    To and excluding

  • :amount_from (Float) —

    From and including

  • :amount_to (Float) —

    To and excluding

  • :departure_location (String) —

    Containing

  • :destination (String) —

    Containing

  • :date_from (String) —

    From and including

  • :date_to (String) —

    To and excluding

  • :is_company_car (BOOLEAN) —

    Equals

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



253
254
255
256
 
# File 'lib/tripletex_api/api/travel_expensemileage_allowance_api.rb', line 253

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

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

BETA

Find mileage allowances corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :travel_expense_id (String) —

    Equals

  • :rate_type_id (String) —

    Equals

  • :rate_category_id (String) —

    Equals

  • :km_from (Float) —

    From and including

  • :km_to (Float) —

    To and excluding

  • :rate_from (Float) —

    From and including

  • :rate_to (Float) —

    To and excluding

  • :amount_from (Float) —

    From and including

  • :amount_to (Float) —

    To and excluding

  • :departure_location (String) —

    Containing

  • :destination (String) —

    Containing

  • :date_from (String) —

    From and including

  • :date_to (String) —

    To and excluding

  • :is_company_car (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/tripletex_api/api/travel_expensemileage_allowance_api.rb', line 280

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

  # query parameters
  query_params = {}
  query_params[:'travelExpenseId'] = opts[:'travel_expense_id'] if !opts[:'travel_expense_id'].nil?
  query_params[:'rateTypeId'] = opts[:'rate_type_id'] if !opts[:'rate_type_id'].nil?
  query_params[:'rateCategoryId'] = opts[:'rate_category_id'] if !opts[:'rate_category_id'].nil?
  query_params[:'kmFrom'] = opts[:'km_from'] if !opts[:'km_from'].nil?
  query_params[:'kmTo'] = opts[:'km_to'] if !opts[:'km_to'].nil?
  query_params[:'rateFrom'] = opts[:'rate_from'] if !opts[:'rate_from'].nil?
  query_params[:'rateTo'] = opts[:'rate_to'] if !opts[:'rate_to'].nil?
  query_params[:'amountFrom'] = opts[:'amount_from'] if !opts[:'amount_from'].nil?
  query_params[:'amountTo'] = opts[:'amount_to'] if !opts[:'amount_to'].nil?
  query_params[:'departureLocation'] = opts[:'departure_location'] if !opts[:'departure_location'].nil?
  query_params[:'destination'] = opts[:'destination'] if !opts[:'destination'].nil?
  query_params[:'dateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'dateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'isCompanyCar'] = opts[:'is_company_car'] if !opts[:'is_company_car'].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 => 'ListResponseMileageAllowance')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TravelExpensemileageAllowanceApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end