Module: Helpers

Includes:
ObjectActivities, ObjectFolders, UserFolders
Included in:
Mints::User
Defined in:
lib/user/helpers/helpers.rb

Instance Method Summary collapse

Methods included from UserFolders

#create_user_folder, #delete_user_folder, #get_user_folder, #get_user_folders, #update_user_folder

Methods included from ObjectFolders

#create_object_folder, #delete_object_folder, #get_object_folder, #get_object_folders, #update_object_folder

Methods included from ObjectActivities

#create_object_activity, #delete_object_activity, #get_object_activities, #get_object_activity, #update_object_activity

Instance Method Details

#generate_seed(objectType, id) ⇒ Object

Generate seed.

Generate seed using object type and object type id.

Parameters

objectType

(String) – Object type.

id

(Integer) – Object type id.

Example

@data = @mints_user.generate_seed("contacts", 1)
[View source]

110
111
112
 
# File 'lib/user/helpers/helpers.rb', line 110

def generate_seed(objectType, id)
    return @client.raw("get", "/helpers/seeds/#{objectType}/#{id}")
end

#get_activities_by_object_type_and_id(object_type, id) ⇒ Object

Get activities by object type and id.

Get activities using an object type and object type id.

Parameters

object_type

(String) – Object type.

id

(Integer) – Object type id.

Example

@data = @mints_user.get_activities_by_object_type_and_id("contacts", 1)
[View source]

59
60
61
 
# File 'lib/user/helpers/helpers.rb', line 59

def get_activities_by_object_type_and_id(object_type, id)
    return @client.raw("get", "/helpers/activities/#{object_type}/#{id}")
end

#get_available_types_from_usage(usage) ⇒ Object

Get available types from usage.

Get available types by usage.

Parameters

usage

() – …

[View source]

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

def get_available_types_from_usage(usage) #TODO: Research use
    return @client.raw("get", "/helpers/available-types/#{usage}")
end

#get_dice_coefficient(options) ⇒ Object

Get dice coefficient.

Get dice coefficient.

Parameters

options

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

Example

options = {
  "table": "contacts",
  "field": "id",
  "word": "1"
}
@data = @mints_user.get_dice_coefficient(options)
[View source]

80
81
82
 
# File 'lib/user/helpers/helpers.rb', line 80

def get_dice_coefficient(options)
    return @client.raw("get", "/helpers/dice-coefficient", options)
end

#get_magic_link_config ⇒ Object

Get magic link config.

Get config used in magic links.

Example

@data = @mints_user.get_magic_link_config
[View source]

42
43
44
 
# File 'lib/user/helpers/helpers.rb', line 42

def get_magic_link_config
    return @client.raw("get", "/helpers/magic-link-config")
end

#get_permission_menu ⇒ Object

Get permission menu.

Get permission menu.

Example

@data = @mints_user.get_permission_menu
[View source]

93
94
95
 
# File 'lib/user/helpers/helpers.rb', line 93

def get_permission_menu
    return @client.raw("get", "/helpers/menu")
end

#slugify(data) ⇒ Object

Slugify.

Slugify a text using an object type.

Parameters

data

(Hash) – Data to be submitted.

Example

[View source]

23
24
25
 
# File 'lib/user/helpers/helpers.rb', line 23

def slugify(data) #TODO: Research use of variable polymorphicObjectType
    return @client.raw("post", "/helpers/slugify", nil, data_transform(data))
end