Module: UserFolders

Included in:
Helpers
Defined in:
lib/user/helpers/user_folders.rb

Instance Method Summary collapse

Instance Method Details

#create_user_folder(data) ⇒ Object

Create user folder.

Create an user folder with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  folder: 'new-user-folder',
  object_type: 'contacts'
}
@data = @cxf_user.create_user_folder(data)



53
54
55
 
# File 'lib/user/helpers/user_folders.rb', line 53

def create_user_folder(data)
  @client.raw('post', '/helpers/folders', nil, data_transform(data))
end

#delete_user_folder(id) ⇒ Object

Delete user folder.

Delete an user folder.

Parameters

id

(Integer) – User folder id.

Example

@data = @cxf_user.delete_user_folder(289)



82
83
84
 
# File 'lib/user/helpers/user_folders.rb', line 82

def delete_user_folder(id)
  @client.raw('delete', "/helpers/folders/#{id}")
end

#get_user_folder(id, options = nil) ⇒ Object

Get user folder.

Get an user folder info.

Parameters

id

(Integer) – User folder id.

options

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

First Example

@data = @cxf_user.get_user_folder(1)

Second Example

options = { fields: 'user_id, folder' }
@data = @cxf_user.get_user_folder(1, options)



37
38
39
 
# File 'lib/user/helpers/user_folders.rb', line 37

def get_user_folder(id, options = nil)
  @client.raw('get', "/helpers/folders/#{id}", options)
end

#get_user_folders(options = nil) ⇒ Object

Get user folders.

Get a collection of user folders.

Parameters

options

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

First Example

@data = @cxf_user.get_user_folders

Second Example

options = { fields: 'folder' }
@data = @cxf_user.get_user_folders(options)



20
21
22
 
# File 'lib/user/helpers/user_folders.rb', line 20

def get_user_folders(options = nil)
  @client.raw('get', '/helpers/folders', options)
end

#update_user_folder(id, data) ⇒ Object

Update user folder.

Update an user folder info.

Parameters

id

(Integer) – User folder id.

data

(Hash) – Data to be submitted.

Example

data = {
  folder:'new-user-folder-modifier',
  object_type:'contact'
}
@data = @cxf_user.update_user_folder(289, data)



70
71
72
 
# File 'lib/user/helpers/user_folders.rb', line 70

def update_user_folder(id, data)
  @client.raw('put', "/helpers/folders/#{id}", nil, data_transform(data))
end