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

Can Users Coach.

Determine if users can coach.

Example

@data = @mints_user.can_users_coach


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

def can_users_coach
    return @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": "new_user_email@example.com",
  "is_confirmed": false,
  "set_password": true, 
  "password": "123456",
  "is_coach": false
}
@data = @mints_user.create_user(data)


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

def create_user(data)
    return @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)
    return @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)


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

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

#get_users ⇒ Object

Get users.

Get a collection of users.

Example

@data = @mints_user.get_users


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

def get_users
    return @client.raw("get", "/config/users")
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": "new_user_name@example.com",
  "is_active": true,
  "is_confirmed": false,
  "roles": ""
}
@data = @mints_user.update_user(14, data)


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

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