Class: Dolibarr::Api::Products::Categories

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Categories

Returns a new instance of Categories.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#list(id:, sortfield: nil, sortorder: nil, limit: nil, page: nil) ⇒ Object

Raises:

  • (ArgumentError) 


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

def list(id:, sortfield: nil, sortorder: nil, limit: nil, page: nil)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :GET,
    '/products/{id}/categories'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page }
  )
end