Module: UserPublicFolders

Included in:
Config
Defined in:
lib/user/config/public_folders.rb

Instance Method Summary collapse

Instance Method Details

#create_public_folder(data) ⇒ Object

Create public folder.

Create a public folder with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Public Folder',
  slug: 'new-public-folder',
  object_type: 'contacts',
  visible: true
}
@data = @mints_user.create_public_folder(data.to_json)



62
63
64
 
# File 'lib/user/config/public_folders.rb', line 62

def create_public_folder(data)
  @client.raw('post', '/config/public-folders', nil, data)
end

#get_public_folder(id) ⇒ Object

Get public folder.

Get a public folder info.

Parameters

id

(Integer) – Public folder id.

options

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

Example

@data = @mints_user.get_public_folder(3)



106
107
108
 
# File 'lib/user/config/public_folders.rb', line 106

def get_public_folder(id)
  @client.raw('get', "/config/public-folders/#{id}")
end

#get_public_folder_support_data(id) ⇒ Object

Get public folder support data.

Get support data used in a public folder.

Parameters

id

(Integer) – Public folder id.

Example

@data = @mints_user.get_public_folder_support_data(1)



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

def get_public_folder_support_data(id)
  @client.raw('get', "/config/public-folders/support-data/#{id}")
end

#get_public_folders(options = nil) ⇒ Object

Get public folders.

Get a collection of public folders.

Example

@data = @mints_user.get_public_folders



44
45
46
 
# File 'lib/user/config/public_folders.rb', line 44

def get_public_folders(options = nil)
  @client.raw('get', '/config/public-folders', options)
end

#get_public_folders_for_object(options) ⇒ Object

Get public folders for object.

Get public folders for object.

Parameters

options

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

Example

options = {
  object_type: "contacts",
  object_id: 1
}
@data = @mints_user.get_public_folders_for_object(options)



35
36
37
 
# File 'lib/user/config/public_folders.rb', line 35

def get_public_folders_for_object(options)
  @client.raw('get', '/config/public-folders/get_public-folders_for_object', options)
end

#sync_public_folders_for_object(data) ⇒ Object

Public Folders

Sync public folders for object.

Sync public folders for object.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  object_type: 'contacts',
  object_id: 1
}
@data = @mints_user.sync_public_folders_for_object(data.to_json)



19
20
21
 
# File 'lib/user/config/public_folders.rb', line 19

def sync_public_folders_for_object(data)
  @client.raw('put', '/config/public-folders/sync_public-folders_for_object', nil, data)
end

#update_public_folder(id, data) ⇒ Object

Update public folder.

Update a public folder info.

Parameters

id

(Integer) – Public folder id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Public Folder Modified',
  slug: 'new-public-folder',
  object_type: 'contacts',
  visible: true
}
@data = @mints_user.update_public_folder(20, data.to_json)



81
82
83
 
# File 'lib/user/config/public_folders.rb', line 81

def update_public_folder(id, data)
  @client.raw('put', "/config/public-folders/#{id}", nil, data)
end