Class: TripletexRubyClient::ProductApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductApi 



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

def api_client
  @api_client
end

Instance Method Details

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

BETA

Delete product.



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

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

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

BETA

Delete image.



76
77
78
79
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 76

def delete_image(id, opts = {})
  delete_image_with_http_info(id, opts)
  nil
end

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

BETA

Delete image.



86
87
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
115
116
117
118
119
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 86

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

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

BETA

Delete product.



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/product_api.rb', line 37

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

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

Get product by ID.

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern



126
127
128
129
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 126

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

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

Get product by ID.

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern



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
166
167
168
169
170
171
172
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 137

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

#post(opts = {}) ⇒ ResponseWrapperProduct

Create new product.

Options Hash (opts):

  • :body (Product) —

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



178
179
180
181
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 178

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

#post_list(opts = {}) ⇒ ListResponseProduct

BETA

Add multiple products.

Options Hash (opts):

  • :body (Array<Product>) —

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



226
227
228
229
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 226

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

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

BETA

Add multiple products.

Options Hash (opts):

  • :body (Array<Product>) —

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



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
265
266
267
268
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 236

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

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

Create new product.

Options Hash (opts):

  • :body (Product) —

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



188
189
190
191
192
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
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 188

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

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

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

Update product.

Options Hash (opts):

  • :body (Product) —

    Partial object describing what should be updated



275
276
277
278
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 275

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

#put_list(opts = {}) ⇒ ListResponseProduct

BETA

Update a list of products.

Options Hash (opts):

  • :body (Array<Product>) —

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



328
329
330
331
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 328

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

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

BETA

Update a list of products.

Options Hash (opts):

  • :body (Array<Product>) —

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 338

def put_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductApi.put_list ...'
  end
  # resource path
  local_var_path = '/product/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 => 'ListResponseProduct')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductApi#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<(ResponseWrapperProduct, Fixnum, Hash)>

Update product.

Options Hash (opts):

  • :body (Product) —

    Partial object describing what should be updated



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

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

#search(opts = {}) ⇒ ListResponseProduct

Find products corresponding with sent data.

Options Hash (opts):

  • :number (String) —

    DEPRECATED. List of product numbers (Integer only)

  • :product_number (Array<String>) —

    List of valid product numbers

  • :name (String) —

    Containing

  • :ean (String) —

    Equals

  • :is_inactive (BOOLEAN) —

    Equals

  • :is_stock_item (BOOLEAN) —

    Equals

  • :is_supplier_product (BOOLEAN) —

    Equals

  • :supplier_id (String) —

    Equals

  • :currency_id (String) —

    Equals

  • :vat_type_id (String) —

    Equals

  • :product_unit_id (String) —

    Equals

  • :department_id (String) —

    Equals

  • :account_id (String) —

    Equals

  • :cost_excluding_vat_currency_from (Float) —

    From and including

  • :cost_excluding_vat_currency_to (Float) —

    To and excluding

  • :price_excluding_vat_currency_from (Float) —

    From and including

  • :price_excluding_vat_currency_to (Float) —

    To and excluding

  • :price_including_vat_currency_from (Float) —

    From and including

  • :price_including_vat_currency_to (Float) —

    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



398
399
400
401
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 398

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

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

Find products corresponding with sent data.

Options Hash (opts):

  • :number (String) —

    DEPRECATED. List of product numbers (Integer only)

  • :product_number (Array<String>) —

    List of valid product numbers

  • :name (String) —

    Containing

  • :ean (String) —

    Equals

  • :is_inactive (BOOLEAN) —

    Equals

  • :is_stock_item (BOOLEAN) —

    Equals

  • :is_supplier_product (BOOLEAN) —

    Equals

  • :supplier_id (String) —

    Equals

  • :currency_id (String) —

    Equals

  • :vat_type_id (String) —

    Equals

  • :product_unit_id (String) —

    Equals

  • :department_id (String) —

    Equals

  • :account_id (String) —

    Equals

  • :cost_excluding_vat_currency_from (Float) —

    From and including

  • :cost_excluding_vat_currency_to (Float) —

    To and excluding

  • :price_excluding_vat_currency_from (Float) —

    From and including

  • :price_excluding_vat_currency_to (Float) —

    To and excluding

  • :price_including_vat_currency_from (Float) —

    From and including

  • :price_including_vat_currency_to (Float) —

    To and excluding

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 430

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

  # query parameters
  query_params = {}
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'productNumber'] = @api_client.build_collection_param(opts[:'product_number'], :multi) if !opts[:'product_number'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'ean'] = opts[:'ean'] if !opts[:'ean'].nil?
  query_params[:'isInactive'] = opts[:'is_inactive'] if !opts[:'is_inactive'].nil?
  query_params[:'isStockItem'] = opts[:'is_stock_item'] if !opts[:'is_stock_item'].nil?
  query_params[:'isSupplierProduct'] = opts[:'is_supplier_product'] if !opts[:'is_supplier_product'].nil?
  query_params[:'supplierId'] = opts[:'supplier_id'] if !opts[:'supplier_id'].nil?
  query_params[:'currencyId'] = opts[:'currency_id'] if !opts[:'currency_id'].nil?
  query_params[:'vatTypeId'] = opts[:'vat_type_id'] if !opts[:'vat_type_id'].nil?
  query_params[:'productUnitId'] = opts[:'product_unit_id'] if !opts[:'product_unit_id'].nil?
  query_params[:'departmentId'] = opts[:'department_id'] if !opts[:'department_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'costExcludingVatCurrencyFrom'] = opts[:'cost_excluding_vat_currency_from'] if !opts[:'cost_excluding_vat_currency_from'].nil?
  query_params[:'costExcludingVatCurrencyTo'] = opts[:'cost_excluding_vat_currency_to'] if !opts[:'cost_excluding_vat_currency_to'].nil?
  query_params[:'priceExcludingVatCurrencyFrom'] = opts[:'price_excluding_vat_currency_from'] if !opts[:'price_excluding_vat_currency_from'].nil?
  query_params[:'priceExcludingVatCurrencyTo'] = opts[:'price_excluding_vat_currency_to'] if !opts[:'price_excluding_vat_currency_to'].nil?
  query_params[:'priceIncludingVatCurrencyFrom'] = opts[:'price_including_vat_currency_from'] if !opts[:'price_including_vat_currency_from'].nil?
  query_params[:'priceIncludingVatCurrencyTo'] = opts[:'price_including_vat_currency_to'] if !opts[:'price_including_vat_currency_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 => 'ListResponseProduct')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_image(id, file, opts = {}) ⇒ ResponseWrapperProduct

BETA

Upload image to Product. Existing image on product will be replaced if exists



490
491
492
493
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 490

def upload_image(id, file, opts = {})
  data, _status_code, _headers = upload_image_with_http_info(id, file, opts)
  data
end

#upload_image_with_http_info(id, file, opts = {}) ⇒ Array<(ResponseWrapperProduct, Fixnum, Hash)>

BETA

Upload image to Product. Existing image on product will be replaced if exists



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/tripletex_ruby_client/api/product_api.rb', line 501

def upload_image_with_http_info(id, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductApi.upload_image ...'
  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 ProductApi.upload_image"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling ProductApi.upload_image"
  end
  # resource path
  local_var_path = '/product/{id}/image'.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  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 => 'ResponseWrapperProduct')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductApi#upload_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end