Class: TripletexRubyClient::CustomerApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomerApi

Returns a new instance of CustomerApi.



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

def api_client
  @api_client
end

Instance Method Details

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

BETA

Delete customer by ID

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 27

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

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

BETA

Delete customer by ID

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



37
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
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 37

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

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

Get customer by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



77
78
79
80
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 77

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

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

Get customer by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ResponseWrapperCustomer data, response status code and response headers



88
89
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
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 88

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerApi.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 CustomerApi.get"
  end
  # resource path
  # query parameters
  {}[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  # form parameters
  # http body (model)
  data, status_code, headers = @api_client.call_api(:GET, '/customer/{id}'.sub('{' + 'id' + '}', id.to_s),
                                                    :header_params => {},
                                                    :query_params => {},
                                                    :form_params => {},
                                                    :body => nil,
                                                    :auth_names => ['tokenAuthScheme'],
                                                    :return_type => 'ResponseWrapperCustomer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(opts = {}) ⇒ ResponseWrapperCustomer

Create customer. Related customer addresses may also be created.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Customer) —

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

Returns:



120
121
122
123
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 120

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

#post_list(opts = {}) ⇒ ListResponseCustomer

BETA

Create multiple customers. Related supplier addresses may also be created.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Customer>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

Returns:



168
169
170
171
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 168

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

#post_list_with_http_info(opts = {}) ⇒ Array<(ListResponseCustomer, Fixnum, Hash)>

BETA

Create multiple customers. Related supplier addresses may also be created.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Customer>) —

    JSON representing a list of new object to be created. Should not have ID and version set.

Returns:

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

    ListResponseCustomer data, response status code and response headers



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/customer_api.rb', line 178

def post_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerApi.post_list ...'
  end
  # resource path
  local_var_path = '/customer/list'

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

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

Create customer. Related customer addresses may also be created.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Customer) —

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

Returns:

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

    ResponseWrapperCustomer data, response status code and response headers



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
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 130

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerApi.post ...'
  end
  # resource path
  local_var_path = '/customer'

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

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

Update customer.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (Customer) —

    Partial object describing what should be updated

Returns:



217
218
219
220
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 217

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

#put_list(opts = {}) ⇒ ListResponseCustomer

BETA

Update multiple customers. Addresses can also be updated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Customer>) —

    JSON representing updates to object. Should have ID and version set.

Returns:



270
271
272
273
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 270

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

#put_list_with_http_info(opts = {}) ⇒ Array<(ListResponseCustomer, Fixnum, Hash)>

BETA

Update multiple customers. Addresses can also be updated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Customer>) —

    JSON representing updates to object. Should have ID and version set.

Returns:

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

    ListResponseCustomer data, response status code and response headers



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
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 280

def put_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerApi.put_list ...'
  end
  # resource path
  local_var_path = '/customer/list'

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

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

Update customer.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :body (Customer) —

    Partial object describing what should be updated

Returns:

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

    ResponseWrapperCustomer data, response status code and response headers



228
229
230
231
232
233
234
235
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
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 228

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

#search(opts = {}) ⇒ ListResponseCustomer

Find customers corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :customer_account_number (String) —

    List of IDs

  • :organization_number (String) —

    Equals

  • :email (String) —

    Equals

  • :invoice_email (String) —

    Equals

  • :is_inactive (BOOLEAN) —

    Equals (default to false)

  • :account_manager_id (String) —

    List of IDs

  • :changed_since (String) —

    Only return elements that have changed since this date and time

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



329
330
331
332
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 329

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

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

Find customers corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :customer_account_number (String) —

    List of IDs

  • :organization_number (String) —

    Equals

  • :email (String) —

    Equals

  • :invoice_email (String) —

    Equals

  • :is_inactive (BOOLEAN) —

    Equals

  • :account_manager_id (String) —

    List of IDs

  • :changed_since (String) —

    Only return elements that have changed since this date and time

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseCustomer data, response status code and response headers



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/tripletex_ruby_client/api/customer_api.rb', line 350

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

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'customerAccountNumber'] = opts[:'customer_account_number'] if !opts[:'customer_account_number'].nil?
  query_params[:'organizationNumber'] = opts[:'organization_number'] if !opts[:'organization_number'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'invoiceEmail'] = opts[:'invoice_email'] if !opts[:'invoice_email'].nil?
  query_params[:'isInactive'] = opts[:'is_inactive'] if !opts[:'is_inactive'].nil?
  query_params[:'accountManagerId'] = opts[:'account_manager_id'] if !opts[:'account_manager_id'].nil?
  query_params[:'changedSince'] = opts[:'changed_since'] if !opts[:'changed_since'].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 => 'ListResponseCustomer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomerApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end