Class: Dolibarr::Api::Contacts::Categories

Inherits:
Object
  • Object
show all
Defined in:
lib/dolibarr-api/api/contacts/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/contacts/categories.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#delete(id:, category_id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def delete(id:, category_id:)
  raise ArgumentError, 'id is required' if id.nil?
  raise ArgumentError, 'category_id is required' if category_id.nil?

  @connection.call(
    :DELETE,
    '/contacts/{id}/categories/{category_id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s))
      .gsub('{category_id}', ERB::Util.url_encode(category_id.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

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

Raises:

  • (ArgumentError) 


23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/dolibarr-api/api/contacts/categories.rb', line 23

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

  @connection.call(
    :GET,
    '/contacts/{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

#update(id:, category_id:) ⇒ Object

Raises:

  • (ArgumentError) 


36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/dolibarr-api/api/contacts/categories.rb', line 36

def update(id:, category_id:)
  raise ArgumentError, 'id is required' if id.nil?
  raise ArgumentError, 'category_id is required' if category_id.nil?

  @connection.call(
    :PUT,
    '/contacts/{id}/categories/{category_id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s))
      .gsub('{category_id}', ERB::Util.url_encode(category_id.to_s)),
    type: nil,
    auth: ['api_key']
  )
end