Class: TripletexApi::CompanyApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CompanyApi

Returns a new instance of CompanyApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Find company 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/company_api.rb', line 29

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

#get_divisions(opts = {}) ⇒ ListResponseCompany

Find divisions.

Parameters:

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

    the optional parameters

Options Hash (opts):

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



85
86
87
88
 
# File 'lib/tripletex_api/api/company_api.rb', line 85

def get_divisions(opts = {})
  data, _status_code, _headers = get_divisions_with_http_info(opts)
  return data
end

#get_divisions_with_http_info(opts = {}) ⇒ Array<(ListResponseCompany, Fixnum, Hash)>

Find divisions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseCompany data, response status code and response headers



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

def get_divisions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_divisions ..."
  end
  # resource path
  local_var_path = "/company/divisions"

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

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

Find company by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperCompany data, response status code and response headers



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/company_api.rb', line 40

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

#get_with_login_access(opts = {}) ⇒ ListResponseCompany

Returns client customers (with accountant/auditor relation) where the current user has login access (proxy login).

Parameters:

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

    the optional parameters

Options Hash (opts):

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



142
143
144
145
 
# File 'lib/tripletex_api/api/company_api.rb', line 142

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

#get_with_login_access_with_http_info(opts = {}) ⇒ Array<(ListResponseCompany, Fixnum, Hash)>

Returns client customers (with accountant/auditor relation) where the current user has login access (proxy login).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseCompany data, response status code and response headers



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/tripletex_api/api/company_api.rb', line 155

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CompanyApi.get_with_login_access ..."
  end
  # resource path
  local_var_path = "/company/>withLoginAccess"

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