Class: Dolibarr::Api::Setup::Extrafields

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Extrafields

Returns a new instance of Extrafields.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(attrname:, elementtype:, setup_create_extrafields_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


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

def create(attrname:, elementtype:, setup_create_extrafields_model: nil)
  raise ArgumentError, 'attrname is required' if attrname.nil?
  raise ArgumentError, 'elementtype is required' if elementtype.nil?

  @connection.call(
    :POST,
    '/setup/extrafields/{elementtype}/{attrname}'
      .gsub('{attrname}', ERB::Util.url_encode(attrname.to_s))
      .gsub('{elementtype}', ERB::Util.url_encode(elementtype.to_s)),
    type: nil,
    auth: ['api_key'],
    body: setup_create_extrafields_model
  )
end

#delete(attrname:, elementtype:) ⇒ Object

Raises:

  • (ArgumentError) 


24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/dolibarr-api/api/setup/extrafields.rb', line 24

def delete(attrname:, elementtype:)
  raise ArgumentError, 'attrname is required' if attrname.nil?
  raise ArgumentError, 'elementtype is required' if elementtype.nil?

  @connection.call(
    :DELETE,
    '/setup/extrafields/{elementtype}/{attrname}'
      .gsub('{attrname}', ERB::Util.url_encode(attrname.to_s))
      .gsub('{elementtype}', ERB::Util.url_encode(elementtype.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#get(attrname:, elementtype:) ⇒ Object

Raises:

  • (ArgumentError) 


38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/dolibarr-api/api/setup/extrafields.rb', line 38

def get(attrname:, elementtype:)
  raise ArgumentError, 'attrname is required' if attrname.nil?
  raise ArgumentError, 'elementtype is required' if elementtype.nil?

  @connection.call(
    :GET,
    '/setup/extrafields/{elementtype}/{attrname}'
      .gsub('{attrname}', ERB::Util.url_encode(attrname.to_s))
      .gsub('{elementtype}', ERB::Util.url_encode(elementtype.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#list(sortfield: nil, sortorder: nil, elementtype: nil, sqlfilters: nil) ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/dolibarr-api/api/setup/extrafields.rb', line 52

def list(sortfield: nil, sortorder: nil, elementtype: nil, sqlfilters: nil)
  @connection.call(
    :GET,
    '/setup/extrafields',
    type: nil,
    auth: ['api_key'],
    query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'elementtype' => elementtype, 'sqlfilters' => sqlfilters }
  )
end

#update(attrname:, elementtype:, setup_update_extrafields_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/dolibarr-api/api/setup/extrafields.rb', line 62

def update(attrname:, elementtype:, setup_update_extrafields_model: nil)
  raise ArgumentError, 'attrname is required' if attrname.nil?
  raise ArgumentError, 'elementtype is required' if elementtype.nil?

  @connection.call(
    :PUT,
    '/setup/extrafields/{elementtype}/{attrname}'
      .gsub('{attrname}', ERB::Util.url_encode(attrname.to_s))
      .gsub('{elementtype}', ERB::Util.url_encode(elementtype.to_s)),
    type: nil,
    auth: ['api_key'],
    body: setup_update_extrafields_model
  )
end