Class: TripletexApi::TravelExpenserateApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TravelExpenserateApi

Returns a new instance of TravelExpenserateApi.



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

def api_client
  @api_client
end

Instance Method Details

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

BETA

Get travel expense rate by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



29
30
31
32
 
# File 'lib/tripletex_api/api/travel_expenserate_api.rb', line 29

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

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

BETA

Get travel expense rate by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



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

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

#search(opts = {}) ⇒ ListResponseTravelExpenseRate

BETA

Find rates corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :rate_category_id (String) —

    Equals

  • :type (String) —

    Equals

  • :is_valid_day_trip (BOOLEAN) —

    Equals

  • :is_valid_accommodation (BOOLEAN) —

    Equals

  • :is_valid_domestic (BOOLEAN) —

    Equals

  • :is_valid_foreign_travel (BOOLEAN) —

    Equals

  • :requires_zone (BOOLEAN) —

    Equals

  • :requires_overnight_accommodation (BOOLEAN) —

    Equals

  • :date_from (String) —

    From and including

  • :date_to (String) —

    To and excluding

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



95
96
97
98
 
# File 'lib/tripletex_api/api/travel_expenserate_api.rb', line 95

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

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

BETA

Find rates corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :rate_category_id (String) —

    Equals

  • :type (String) —

    Equals

  • :is_valid_day_trip (BOOLEAN) —

    Equals

  • :is_valid_accommodation (BOOLEAN) —

    Equals

  • :is_valid_domestic (BOOLEAN) —

    Equals

  • :is_valid_foreign_travel (BOOLEAN) —

    Equals

  • :requires_zone (BOOLEAN) —

    Equals

  • :requires_overnight_accommodation (BOOLEAN) —

    Equals

  • :date_from (String) —

    From and including

  • :date_to (String) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/tripletex_api/api/travel_expenserate_api.rb', line 118

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TravelExpenserateApi.search ..."
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['PER_DIEM', 'ACCOMMODATION_ALLOWANCE', 'MILEAGE_ALLOWANCE'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of PER_DIEM, ACCOMMODATION_ALLOWANCE, MILEAGE_ALLOWANCE'
  end
  # resource path
  local_var_path = "/travelExpense/rate"

  # query parameters
  query_params = {}
  query_params[:'rateCategoryId'] = opts[:'rate_category_id'] if !opts[:'rate_category_id'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'isValidDayTrip'] = opts[:'is_valid_day_trip'] if !opts[:'is_valid_day_trip'].nil?
  query_params[:'isValidAccommodation'] = opts[:'is_valid_accommodation'] if !opts[:'is_valid_accommodation'].nil?
  query_params[:'isValidDomestic'] = opts[:'is_valid_domestic'] if !opts[:'is_valid_domestic'].nil?
  query_params[:'isValidForeignTravel'] = opts[:'is_valid_foreign_travel'] if !opts[:'is_valid_foreign_travel'].nil?
  query_params[:'requiresZone'] = opts[:'requires_zone'] if !opts[:'requires_zone'].nil?
  query_params[:'requiresOvernightAccommodation'] = opts[:'requires_overnight_accommodation'] if !opts[:'requires_overnight_accommodation'].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[:'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 => 'ListResponseTravelExpenseRate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TravelExpenserateApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end