Module: ObjectFolders

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

Instance Method Summary collapse

Instance Method Details

#create_object_folder(data) ⇒ Object

Create object folder.

Create an object folder with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  "folder_id": 1,
  "object_id": 1
}
@data = @mints_user.create_object_folder(data)


51
52
53
 
# File 'lib/user/helpers/object_folders.rb', line 51

def create_object_folder(data)
    return @client.raw("post", "/helpers/object-folders", nil, data_transform(data))
end

#delete_object_folder(id) ⇒ Object

Delete object folder.

Delete an object folder.

Parameters

id

(Integer) – Object folder id.

Example

@data = @mints_user.delete_object_folder(2)


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

def delete_object_folder(id)
    return @client.raw("delete", "/helpers/object-folders/#{id}")
end

#get_object_folder(id, options = nil) ⇒ Object

Get object folder.

Get an object folder info.

Parameters

id

(Integer) – Object folders id.

options

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

First Example

@data = @mints_user.get_object_folder(1)

Second Example

options = { "fields": "id" }
@data = @mints_user.get_object_folder(1, options)


35
36
37
 
# File 'lib/user/helpers/object_folders.rb', line 35

def get_object_folder(id, options = nil)
    return @client.raw("get", "/helpers/object-folders/#{id}", options)
end

#get_object_folders(options = nil) ⇒ Object

Get object folders.

Get a collection of object folders.

Parameters

options

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

First Example

@data = @mints_user.get_object_folders

Second Example

options = { "fields": "id" }
@data = @mints_user.get_object_folders(options)


18
19
20
 
# File 'lib/user/helpers/object_folders.rb', line 18

def get_object_folders(options = nil)
    return @client.raw("get", "/helpers/object-folders", options)
end

#update_object_folder(id, data) ⇒ Object

Update object folder.

Update an object folder info.

Parameters

id

(Integer) – Object folder id.

data

(Hash) – Data to be submitted.

Example

data = {
  "folder_id": 2
}
@data = @mints_user.update_object_folder(1, data)


67
68
69
 
# File 'lib/user/helpers/object_folders.rb', line 67

def update_object_folder(id, data)
    return @client.raw("put", "/helpers/object-folders/#{id}", nil, data_transform(data))
end