Class: Emarsys::File

Inherits:

DataObject

• Object
• DataObject
• Emarsys::File

Defined in:

lib/emarsys/data_objects/file.rb

Overview

Methods for the File API

Class Method Summary

• .collection(account: nil, **params) ⇒ Hash

  List files.

• .create(filename:, file:, folder: nil, account: nil) ⇒ Hash

  Upload a file to the media database.

Methods inherited from DataObject

delete, get, parameterize_params, post, put, #request

Class Method Details

.collection(account: nil, **params) ⇒ Hash

List files

Examples:

Emarsys::File.collection
Emarsys::File.collection(:folder => 3)

Parameters:

• params (Hash) —

  optional search params

Options Hash (**params):

• :folder (Integer, String) —

  filter by folder

Returns:

• (Hash) —

  List of files

# File 'lib/emarsys/data_objects/file.rb', line 18

def collection(account: nil, **params)
  get account, 'file', params
end

.create(filename:, file:, folder: nil, account: nil) ⇒ Hash

Upload a file to the media database

Examples:

Emarsys::File.create("my_file.jpg", "asdhkajsh...")
Emarsys::File.create("my_file.jpg", "asdhkajsh...", 3)

Parameters:

• filename (String) —

  The filename

• file (String) —

  Base64 encoded version of the file

• folder (Integer, String) (defaults to: nil) —

  optional folder to put the file into

Returns:

• (Hash) —

  Result data

# File 'lib/emarsys/data_objects/file.rb', line 31

def create(filename:, file:, folder: nil, account: nil)
  params = {:filename => filename, :file => file}
  params.merge!(:folder => folder) unless folder.nil?
  post account, 'file', params
end