Class: Dolibarr::Api::Setup::Modules

Inherits:
Object
  • Object
show all
Defined in:
lib/dolibarr-api/api/setup/modules.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Modules

Returns a new instance of Modules.



5
6
7
 
# File 'lib/dolibarr-api/api/setup/modules.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#disable(modulename:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def disable(modulename:)
  raise ArgumentError, 'modulename is required' if modulename.nil?

  @connection.call(
    :PUT,
    '/setup/modules/{modulename}/disable'
      .gsub('{modulename}', ERB::Util.url_encode(modulename.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#enable(modulename:) ⇒ Object

Raises:

  • (ArgumentError) 


21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/dolibarr-api/api/setup/modules.rb', line 21

def enable(modulename:)
  raise ArgumentError, 'modulename is required' if modulename.nil?

  @connection.call(
    :PUT,
    '/setup/modules/{modulename}/enable'
      .gsub('{modulename}', ERB::Util.url_encode(modulename.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#list ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/dolibarr-api/api/setup/modules.rb', line 33

def list
  @connection.call(
    :GET,
    '/setup/modules',
    type: nil,
    auth: ['api_key']
  )
end

#status(origin:, status: nil) ⇒ Object

Raises:

  • (ArgumentError) 


42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/dolibarr-api/api/setup/modules.rb', line 42

def status(origin:, status: nil)
  raise ArgumentError, 'origin is required' if origin.nil?

  @connection.call(
    :GET,
    '/setup/modules/status/{origin}'
      .gsub('{origin}', ERB::Util.url_encode(origin.to_s)),
    type: nil,
    auth: ['api_key'],
    query: { 'status' => status }
  )
end