Class: Dolibarr::Api::Users::Email

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Email

Returns a new instance of Email.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#get(email:, includepermissions: nil) ⇒ Object

Raises:

  • (ArgumentError) 


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

def get(email:, includepermissions: nil)
  raise ArgumentError, 'email is required' if email.nil?

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