Class: Dolibarr::Api::Users::Groups

Inherits:
Object
  • Object
show all
Defined in:
lib/dolibarr-api/api/users/groups.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Groups

Returns a new instance of Groups.



5
6
7
 
# File 'lib/dolibarr-api/api/users/groups.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(users_create_groups_model: nil) ⇒ Object 



9
10
11
12
13
14
15
16
17
 
# File 'lib/dolibarr-api/api/users/groups.rb', line 9

def create(users_create_groups_model: nil)
  @connection.call(
    :POST,
    '/users/groups',
    type: nil,
    auth: ['api_key'],
    body: users_create_groups_model
  )
end

#delete(group:) ⇒ Object

Raises:

  • (ArgumentError) 


19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/dolibarr-api/api/users/groups.rb', line 19

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

  @connection.call(
    :DELETE,
    '/users/groups/{group}'
      .gsub('{group}', ERB::Util.url_encode(group.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#get(group:, load_members: nil) ⇒ Object

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/dolibarr-api/api/users/groups.rb', line 31

def get(group:, load_members: nil)
  raise ArgumentError, 'group is required' if group.nil?

  @connection.call(
    :GET,
    '/users/groups/{group}'
      .gsub('{group}', ERB::Util.url_encode(group.to_s)),
    type: Dolibarr::Api::Models::Obj,
    auth: ['api_key'],
    query: { 'load_members' => load_members }
  )
end

#list(sortfield: nil, sortorder: nil, limit: nil, page: nil, group_ids: nil, sqlfilters: nil, properties: nil) ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/dolibarr-api/api/users/groups.rb', line 44

def list(sortfield: nil, sortorder: nil, limit: nil, page: nil, group_ids: nil, sqlfilters: nil, properties: nil)
  @connection.call(
    :GET,
    '/users/groups',
    type: nil,
    auth: ['api_key'],
    query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'group_ids' => group_ids, 'sqlfilters' => sqlfilters, 'properties' => properties }
  )
end

#list_get(id:) ⇒ Object

Raises:

  • (ArgumentError) 


54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/dolibarr-api/api/users/groups.rb', line 54

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

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

#update(group:, users_update_groups_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/dolibarr-api/api/users/groups.rb', line 66

def update(group:, users_update_groups_model: nil)
  raise ArgumentError, 'group is required' if group.nil?

  @connection.call(
    :PUT,
    '/users/groups/{group}'
      .gsub('{group}', ERB::Util.url_encode(group.to_s)),
    type: Dolibarr::Api::Models::Obj,
    auth: ['api_key'],
    body: users_update_groups_model
  )
end