Module: Importers

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

Instance Method Summary collapse

Instance Method Details

#create_importer(data) ⇒ Object

Create importer.

Create an importer with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  "name": "New Importer",
  "module": "crm"
}
@data = @mints_user.create_importer(data)


144
145
146
 
# File 'lib/user/config/importers.rb', line 144

def create_importer(data)
    return @client.raw("post", "/config/importers", nil, data_transform(data))
end

#delete_importer(id) ⇒ Object

Delete importer.

Delete a importer.

Parameters

id

(Integer) – Importer id.

Example

@data = @mints_user.delete_importer(4)


172
173
174
 
# File 'lib/user/config/importers.rb', line 172

def delete_importer(id)
    return @client.raw("delete", "/config/importers/#{id}")
end

#get_importer(id, options = nil) ⇒ Object

Get importer.

Get an importer info.

Parameters

id

(Integer) – Importer id.

options

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

First Example

@data = @mints_user.get_importer(1)

Second Example

options = { "fields": "name" }
@data = @mints_user.get_importer(1, options)


128
129
130
 
# File 'lib/user/config/importers.rb', line 128

def get_importer(id, options = nil)
    return @client.raw("get", "/config/importers/#{id}", options)
end

#get_importers(options = nil) ⇒ Object

Get importers.

Get a collection of importers.

Parameters

options

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

First Example

@data = @mints_user.get_importers

Second Example

options = { "fields": "name" }
@data = @mints_user.get_importers(options)


111
112
113
 
# File 'lib/user/config/importers.rb', line 111

def get_importers(options = nil)
    return @client.raw("get", "/config/importers", options)
end

#get_importers_attributes(options = nil) ⇒ Object

Get importers attributes.

Get import attributes of modules in a table.

Parameters

options

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

Example

options = {
  "table": "contacts",
  "module": "crm"
}
@data = @mints_user.get_importers_attributes(options)


55
56
57
 
# File 'lib/user/config/importers.rb', line 55

def get_importers_attributes(options = nil)
    return @client.raw("get", "/config/importers/attributes", options)
end

#get_importers_configuration ⇒ Object

Get importers configuration.

Get configurations of importers.

Example

@data = @mints_user.get_importers_configuration


24
25
26
 
# File 'lib/user/config/importers.rb', line 24

def get_importers_configuration
    return @client.raw("get", "/config/importers/configuration")
end

#get_importers_pusher_key ⇒ Object

Get importers pusher key.

Get the pusher key of importers.

Example

@data = @mints_user.get_importers_pusher_key


181
182
183
 
# File 'lib/user/config/importers.rb', line 181

def get_importers_pusher_key
    return @client.raw("get", "/config/pusher_key")
end

#get_importers_results(options) ⇒ Object

Get importers results.

Get a results of importers.

Parameters

options

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

Example

options = { "ip_id": 1 }
@data = @mints_user.get_importers_results(options)


15
16
17
 
# File 'lib/user/config/importers.rb', line 15

def get_importers_results(options) #FIXME: Query doesnt get results. Maybe no data in db.
    return @client.raw("get", "/config/importers/results", options)
end

#get_importing_process_status(options = nil) ⇒ Object

Get importing process status.

Get importing process status by importer ids.

Parameters

options

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

Example

options = {
  "ids": "1,2,3"
}
@data = @mints_user.get_importing_process_status(options)


39
40
41
 
# File 'lib/user/config/importers.rb', line 39

def get_importing_process_status(options = nil)
    return @client.raw("get", "/config/importers/importing_process_status", options)
end

#import_row(data) ⇒ Object

Import row.

Import a row.

Parameters

data

(Hash) – Data to be submitted.

Example


83
84
85
 
# File 'lib/user/config/importers.rb', line 83

def import_row(data) #TODO: Research use
    return @client.raw("post", "/config/importers/import_row", nil, data)
end

#remove_importers_active_process(data) ⇒ Object

Remove importers active process.

Remove an active process in an importer.

Parameters

data

(Hash) – Data to be submitted.

Example


95
96
97
 
# File 'lib/user/config/importers.rb', line 95

def remove_importers_active_process(data) #FIXME: Cannot get property 'active_importing_process' of non-object. 
    return @client.raw("post", "/config/importers/removeActiveProcess", nil, data_transform(data))
end

#update_importer(id, data) ⇒ Object

Update importer.

Update an importer info.

Parameters

id

(Integer) – Importer id.

data

(Hash) – Data to be submitted.

Example

data = {
  "name": "New Importer Modified"
}
@data = @mints_user.update_importer(4, data)


160
161
162
 
# File 'lib/user/config/importers.rb', line 160

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

#upload_importer(id, data) ⇒ Object

Upload importer.

Upload to an importer.

Parameters

id

(Integer) – Importer id.

data

(Hash) – Data to be submitted.

Example

data = {
  "csv": "archive.csv"
}
@data = @mints_user.upload_importer(1, data.to_json)


71
72
73
 
# File 'lib/user/config/importers.rb', line 71

def upload_importer(id, data) #TODO: Search for csv archives
    return @client.raw("post", "/config/importers/#{id}/upload", nil, data)
end