Module: Ruconomic::API::Product

Extended by:
WebService
Defined in:
lib/ruconomic/api/product.rb

Class Method Summary collapse

Class Method Details

.createHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates a new product. Parameters: number: The number of the new product. productGroupHandle: The product group of the new product. name: The name of the new product.


216
217
218
219
220
# File 'lib/ruconomic/api/product.rb', line 216

def self.create
  response = invoke('Product_Create') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.create_from_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates a new product from a data object. Parameters: data: The data object that specifies the properties of the new product.


321
322
323
324
325
# File 'lib/ruconomic/api/product.rb', line 321

def self.create_from_data
  response = invoke('Product_CreateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.create_from_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates new products from data objects. Parameters: dataArray: The array of data objects that specifies the properties of the new products.


333
334
335
336
337
# File 'lib/ruconomic/api/product.rb', line 333

def self.create_from_data_array
  response = invoke('Product_CreateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.deleteHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Deletes a product. Parameters: productHandle: Handle for the product.


309
310
311
312
313
# File 'lib/ruconomic/api/product.rb', line 309

def self.delete
  response = invoke('Product_Delete') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_bar_codeHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handles for the products with a given bar code. Parameters: barCode: The bar code to search for.


297
298
299
300
301
# File 'lib/ruconomic/api/product.rb', line 297

def self.find_by_bar_code
  response = invoke('Product_FindByBarCode') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handles for the products with a given name. Parameters: name: The name to search for.


285
286
287
288
289
# File 'lib/ruconomic/api/product.rb', line 285

def self.find_by_name
  response = invoke('Product_FindByName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_numberHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handle for the product with a given number. Parameters: name: The number to search for.


261
262
263
264
265
# File 'lib/ruconomic/api/product.rb', line 261

def self.find_by_number
  response = invoke('Product_FindByNumber') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_number_listHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns an array with handles for the products corresponding to the given product numbers. If a product with a given number does not exist or if no number is given then the array contains nothing at that index. Parameters: numbers: The numbers to search for.


273
274
275
276
277
# File 'lib/ruconomic/api/product.rb', line 273

def self.find_by_number_list
  response = invoke('Product_FindByNumberList') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_allHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handles for all products.


227
228
229
230
231
# File 'lib/ruconomic/api/product.rb', line 227

def self.get_all
  response = invoke('Product_GetAll') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_all_accessibleHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handles for all accessible products.


238
239
240
241
242
# File 'lib/ruconomic/api/product.rb', line 238

def self.get_all_accessible
  response = invoke('Product_GetAllAccessible') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_all_updatedHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Return handles for all products from date. fromDate is based on CET. includeCalculatedProperties, when set to True, includes products with only stock status updated.


249
250
251
252
253
# File 'lib/ruconomic/api/product.rb', line 249

def self.get_all_updated
  response = invoke('Product_GetAllUpdated') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_availableHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the quantity in stock that is not yet used on orders for a product. Available is only accessible when there is access to the Stock add-on module. Parameters: productHandle: Handle for the product.


204
205
206
207
208
# File 'lib/ruconomic/api/product.rb', line 204

def self.get_available
  response = invoke('Product_GetAvailable') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_bar_codeHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the bar code of a product. Parameters: productHandle: Handle for the product.


489
490
491
492
493
# File 'lib/ruconomic/api/product.rb', line 489

def self.get_bar_code
  response = invoke('Product_GetBarCode') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_cost_priceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the cost price of a product. Parameters: productHandle: Handle for the product.


525
526
527
528
529
# File 'lib/ruconomic/api/product.rb', line 525

def self.get_cost_price
  response = invoke('Product_GetCostPrice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns an product data object for a given product. Parameters: entityHandle: A handle for the product.


369
370
371
372
373
# File 'lib/ruconomic/api/product.rb', line 369

def self.get_data
  response = invoke('Product_GetData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns product data objects for a given set of product handles. Parameters: entityHandles: An array of the product handles.


381
382
383
384
385
# File 'lib/ruconomic/api/product.rb', line 381

def self.get_data_array
  response = invoke('Product_GetDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_departmentHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the department of a product. The department is only accessible when there is access to the Dimension add-on module. Parameters: productHandle: Handle for the product.


120
121
122
123
124
# File 'lib/ruconomic/api/product.rb', line 120

def self.get_department
  response = invoke('Product_GetDepartment') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_descriptionHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the description of a product. Parameters: productHandle: Handle for the product.


453
454
455
456
457
# File 'lib/ruconomic/api/product.rb', line 453

def self.get_description
  response = invoke('Product_GetDescription') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_distribution_keyHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the distribution key of a product. The distribution key is only accessible when there is access to the Dimension add-on module. Parameters: productHandle: Handle for the product.


144
145
146
147
148
# File 'lib/ruconomic/api/product.rb', line 144

def self.get_distribution_key
  response = invoke('Product_GetDistributionKey') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_in_stockHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the quantity in stock of a product. InStock is only accessible when there is access to the Stock add-on module. Parameters: productHandle: Handle for the product.


168
169
170
171
172
# File 'lib/ruconomic/api/product.rb', line 168

def self.get_in_stock
  response = invoke('Product_GetInStock') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_is_accessibleHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets whether a product is accessible. Parameters: productHandle: Handle for the product.


84
85
86
87
88
# File 'lib/ruconomic/api/product.rb', line 84

def self.get_is_accessible
  response = invoke('Product_GetIsAccessible') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the name of a product. Parameters: productHandle: Handle for the product.


429
430
431
432
433
# File 'lib/ruconomic/api/product.rb', line 429

def self.get_name
  response = invoke('Product_GetName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_numberHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the number of a product. Parameters: productHandle: Handle for the product.


393
394
395
396
397
# File 'lib/ruconomic/api/product.rb', line 393

def self.get_number
  response = invoke('Product_GetNumber') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_on_orderHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the quantity in stock that is already used on orders for a product. OnOrder is only accessible when there is access to the Stock add-on module. Parameters: productHandle: Handle for the product.


180
181
182
183
184
# File 'lib/ruconomic/api/product.rb', line 180

def self.get_on_order
  response = invoke('Product_GetOnOrder') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_orderedHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets quantity ordered from suppliers for a product. Ordered is only accessible when there is access to the Stock add-on module. Parameters: productHandle: Handle for the product.


192
193
194
195
196
# File 'lib/ruconomic/api/product.rb', line 192

def self.get_ordered
  response = invoke('Product_GetOrdered') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_product_groupHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the product group of a product. Parameters: productHandle: Handle for the product.


405
406
407
408
409
# File 'lib/ruconomic/api/product.rb', line 405

def self.get_product_group
  response = invoke('Product_GetProductGroup') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end
Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the recommended price of a product. Parameters: productHandle: Handle for the product.


24
25
26
27
28
# File 'lib/ruconomic/api/product.rb', line 24

def self.get_recommended_price
  response = invoke('Product_GetRecommendedPrice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_sales_priceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the sales price of a product. Parameters: productHandle: Handle for the product.


513
514
515
516
517
# File 'lib/ruconomic/api/product.rb', line 513

def self.get_sales_price
  response = invoke('Product_GetSalesPrice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_unitHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets handle for the primary unit of a product. Parameters: productHandle: Handle for the product.


48
49
50
51
52
# File 'lib/ruconomic/api/product.rb', line 48

def self.get_unit
  response = invoke('Product_GetUnit') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_volumeHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the volume of a product. Parameters: productHandle: Handle for the product.


108
109
110
111
112
# File 'lib/ruconomic/api/product.rb', line 108

def self.get_volume
  response = invoke('Product_GetVolume') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_bar_codeHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the bar code of a product. Parameters: productHandle: Handle for the product. value: The new bar code of the product.


477
478
479
480
481
# File 'lib/ruconomic/api/product.rb', line 477

def self.set_bar_code
  response = invoke('Product_SetBarCode') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_cost_priceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the cost price of a product. Parameters: productHandle: Handle for the product. value: The new cost price of the product.


12
13
14
15
16
# File 'lib/ruconomic/api/product.rb', line 12

def self.set_cost_price
  response = invoke('Product_SetCostPrice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_departmentHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the department of a product. The department is only accessible when there is access to the Dimension add-on module. The department cannot be set when the distribution key is set. Parameters: productHandle: Handle for the product. value: Handle for the new department of the product.


132
133
134
135
136
# File 'lib/ruconomic/api/product.rb', line 132

def self.set_department
  response = invoke('Product_SetDepartment') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_descriptionHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the description of a product. Parameters: productHandle: Handle for the product. value: The new description of the product.


465
466
467
468
469
# File 'lib/ruconomic/api/product.rb', line 465

def self.set_description
  response = invoke('Product_SetDescription') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_distribution_keyHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the distribution key of the product. The distribution key is only accessible when there is access to the Dimension add-on module. The distribution key cannot be set when the department is set. Parameters: productHandle: Handle for the product. value: Handle for the new distribution key of the product.


156
157
158
159
160
# File 'lib/ruconomic/api/product.rb', line 156

def self.set_distribution_key
  response = invoke('Product_SetDistributionKey') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_is_accessibleHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets whether a product is accessible. Parameters: productHandle: Handle for the product. value: Value that indicates whether the product should be accessible.


72
73
74
75
76
# File 'lib/ruconomic/api/product.rb', line 72

def self.set_is_accessible
  response = invoke('Product_SetIsAccessible') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the name of a product. Parameters: productHandle: Handle for the product. value: The new name of the product.


441
442
443
444
445
# File 'lib/ruconomic/api/product.rb', line 441

def self.set_name
  response = invoke('Product_SetName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_product_groupHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the product group of a product. Parameters: productHandle: Handle for the product. valueHandle: Handle for new product group of the product.


417
418
419
420
421
# File 'lib/ruconomic/api/product.rb', line 417

def self.set_product_group
  response = invoke('Product_SetProductGroup') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end
Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the recommended price of a product. Parameters: productHandle: Handle for the product. value: The new recommended price of the product.


36
37
38
39
40
# File 'lib/ruconomic/api/product.rb', line 36

def self.set_recommended_price
  response = invoke('Product_SetRecommendedPrice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_sales_priceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the sales price of a product. Parameters: productHandle: Handle for the product. value: The new sales price of the product.


501
502
503
504
505
# File 'lib/ruconomic/api/product.rb', line 501

def self.set_sales_price
  response = invoke('Product_SetSalesPrice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_unitHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets primary unit of a product. Parameters: productHandle: Handle for the product. value: Handle for new primary unit of the product.


60
61
62
63
64
# File 'lib/ruconomic/api/product.rb', line 60

def self.set_unit
  response = invoke('Product_SetUnit') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_volumeHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the volume of a product. Parameters: productHandle: Handle for the product. value: The new volume value of the product.


96
97
98
99
100
# File 'lib/ruconomic/api/product.rb', line 96

def self.set_volume
  response = invoke('Product_SetVolume') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.update_from_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Updates a product from a data object. Parameters: data: The data object.


357
358
359
360
361
# File 'lib/ruconomic/api/product.rb', line 357

def self.update_from_data
  response = invoke('Product_UpdateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.update_from_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Update products from data objects. Parameters: dataArray: The array of data objects.


345
346
347
348
349
# File 'lib/ruconomic/api/product.rb', line 345

def self.update_from_data_array
  response = invoke('Product_UpdateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end