Module: ExportConfiguration

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

Instance Method Summary collapse

Instance Method Details

#create_export_configuration(data) ⇒ Object

Create export.

Create an export with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New configuration',
  slug: 'new-configuration',
  object_model: 'Contact',
  config_json: {}
}
@data = @mints_user.create_export(data)



46
47
48
 
# File 'lib/user/config/export_configuration.rb', line 46

def create_export_configuration(data)
  @client.raw('post', '/config/export-configurations', nil, data_transform(data))
end

#get_export_configuration(id) ⇒ Object

Get export.

Get an export configuration info.

Parameters

id

(Integer) – Export configuration id.

Example

@data = @mints_user.get_export(10)



28
29
30
 
# File 'lib/user/config/export_configuration.rb', line 28

def get_export_configuration(id)
  @client.raw('get', "/config/export-configurations/#{id}")
end

#get_export_configurations(options = nil) ⇒ Object

Get export_configurations.

Get a collection of export_configurations.

Parameters

options

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

First Example

@data = @mints_user.get_export_configurations

Second Example

options = { sort: 'id' }
@data = @mints_user.get_export_configurations(options)



16
17
18
 
# File 'lib/user/config/export_configuration.rb', line 16

def get_export_configurations(options = nil)
  @client.raw('get', '/config/export-configurations', options)
end

#update_export_configuration(id, data) ⇒ Object

Update export configuration.

Update an export configuration info.

Parameters

id

(Integer) – Export configuration id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New configuration',
  slug: 'new-configuration',
  object_model: 'Contact',
  config_json: {}
}
@data = @mints_user.update_export(36, data)



65
66
67
 
# File 'lib/user/config/export_configuration.rb', line 65

def update_export_configuration(id, data)
  @client.raw('put', "/config/export-configurations/#{id}", nil, data_transform(data))
end