Module: Users

Included in:
CRM, Config
Defined in:
lib/user/crm/users.rb,
lib/user/config/users.rb

Instance Method Summary collapse

Instance Method Details

#can_users_coach ⇒ Object

Users

Can Users Coach.

Determine if users can coach.

Example

@data = @mints_user.can_users_coach



11
12
13
 
# File 'lib/user/config/users.rb', line 11

def can_users_coach
  @client.raw('get', '/config/users/can_coach')
end

#create_user(data) ⇒ Object

Create user.

Create an user with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  name: 'New User Name',
  email: '[email protected]',
  is_confirmed: false,
  set_password: true,
  password: '123456',
  is_coach: false
}
@data = @mints_user.create_user(data)



52
53
54
 
# File 'lib/user/config/users.rb', line 52

def create_user(data)
  @client.raw('post', '/config/users', nil, data_transform(data))
end

#get_crm_users(options = nil) ⇒ Object

Get crm users.

Get users info in crm.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @mints_user.get_crm_users

Second Example

options = { sort: 'id', fields: 'id, email' }
@data = @mints_user.get_crm_users(options)



19
20
21
 
# File 'lib/user/crm/users.rb', line 19

def get_crm_users(options = nil)
  @client.raw('get', '/crm/users', options)
end

#get_user(id) ⇒ Object

Get user.

Get an user info.

Parameters

id

(Integer) – User id.

Example

@data = @mints_user.get_user(8)



32
33
34
 
# File 'lib/user/config/users.rb', line 32

def get_user(id)
  @client.raw('get', "/config/users/#{id}")
end

#get_users(options) ⇒ Object

Get users.

Get a collection of users.

Example

@data = @mints_user.get_users



20
21
22
 
# File 'lib/user/config/users.rb', line 20

def get_users(options)
  @client.raw('get', '/config/users', options)
end

#update_user(id, data) ⇒ Object

Update user.

Update an user info.

Parameters

id

(Integer) – User id.

data

(Hash) – Data to be submitted.

Example

data = {
  name: 'New User Name Modified',
  email: '[email protected]',
  is_active: true,
  is_confirmed: false,
  roles: ''
}
@data = @mints_user.update_user(14, data)



72
73
74
 
# File 'lib/user/config/users.rb', line 72

def update_user(id, data)
  @client.raw('put', "/config/users/#{id}", nil, data_transform(data))
end