Module: Exports

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

Instance Method Summary collapse

Instance Method Details

#create_export(data) ⇒ Object

Create export.

Create an export with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New export',
  slug: 'new-export',
  object_type: 'contacts'
}
@data = @mints_user.create_export(data)



45
46
47
 
# File 'lib/user/config/exports.rb', line 45

def create_export(data)
  @client.raw('post', '/config/exports', nil, data_transform(data))
end

#get_export(id) ⇒ Object

Get export.

Get an export info.

Parameters

id

(Integer) – Export id.

Example

@data = @mints_user.get_export(10)



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

def get_export(id)
  @client.raw('get', "/config/exports/#{id}")
end

#get_exports(options = nil) ⇒ Object

Get exports.

Get a collection of exports.

Parameters

options

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

First Example

@data = @mints_user.get_exports

Second Example

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



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

def get_exports(options = nil)
  @client.raw('get', '/config/exports', options)
end

#update_export(id, data) ⇒ Object

Update export.

Update an export info.

Parameters

id

(Integer) – Export id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New export',
  slug: 'new-export',
  object_type: 'contacts'
}
@data = @mints_user.update_export(36, data)



63
64
65
 
# File 'lib/user/config/exports.rb', line 63

def update_export(id, data)
  @client.raw('put', "/config/exports/#{id}", nil, data_transform(data))
end