Class: Dolibarr::Api::Products::Ref

Inherits:
Object
  • Object
show all
Defined in:
lib/dolibarr-api/api/products/ref.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Ref

Returns a new instance of Ref.



5
6
7
 
# File 'lib/dolibarr-api/api/products/ref.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#get(ref:, includestockdata: nil, includesubproducts: nil, includeparentid: nil, includetrans: nil) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/dolibarr-api/api/products/ref.rb', line 9

def get(ref:, includestockdata: nil, includesubproducts: nil, includeparentid: nil, includetrans: nil)
  raise ArgumentError, 'ref is required' if ref.nil?

  @connection.call(
    :GET,
    '/products/ref/{ref}'
      .gsub('{ref}', ERB::Util.url_encode(ref.to_s)),
    type: nil,
    auth: ['api_key'],
    query: { 'includestockdata' => includestockdata, 'includesubproducts' => includesubproducts, 'includeparentid' => includeparentid, 'includetrans' => includetrans }
  )
end

#variants(ref:) ⇒ Object

Raises:

  • (ArgumentError) 


22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/dolibarr-api/api/products/ref.rb', line 22

def variants(ref:)
  raise ArgumentError, 'ref is required' if ref.nil?

  @connection.call(
    :GET,
    '/products/ref/{ref}/variants'
      .gsub('{ref}', ERB::Util.url_encode(ref.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#variants_post(ref:, products_add_variant_by_product_ref_model:) ⇒ Object

Raises:

  • (ArgumentError) 


34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/dolibarr-api/api/products/ref.rb', line 34

def variants_post(ref:, products_add_variant_by_product_ref_model:)
  raise ArgumentError, 'ref is required' if ref.nil?
  raise ArgumentError, 'products_add_variant_by_product_ref_model is required' if products_add_variant_by_product_ref_model.nil?

  @connection.call(
    :POST,
    '/products/ref/{ref}/variants'
      .gsub('{ref}', ERB::Util.url_encode(ref.to_s)),
    type: nil,
    auth: ['api_key'],
    body: products_add_variant_by_product_ref_model
  )
end