Class: TripletexRubyClient::MunicipalityApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MunicipalityApi

Returns a new instance of MunicipalityApi.



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

def api_client
  @api_client
end

Instance Method Details

#search(opts = {}) ⇒ ListResponseMunicipality

BETA

Get municipalities.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_payroll_tax_zones (BOOLEAN) —

    Equals (default to true)

  • :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/municipality_api.rb', line 31

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

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

BETA

Get municipalities.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_payroll_tax_zones (BOOLEAN) —

    Equals

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseMunicipality 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/municipality_api.rb', line 45

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MunicipalityApi.search ...'
  end
  # resource path
  local_var_path = '/municipality'

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