Class: Emarsys::Source

Inherits:

DataObject

• Object
• DataObject
• Emarsys::Source

Defined in:

lib/emarsys/data_objects/source.rb

Overview

Methods for the Source API

Class Method Summary

• .collection(account: nil) ⇒ Hash

  List sources.

• .create(name:, account: nil) ⇒ Hash

  Create a new source.

• .destroy(id, account: nil) ⇒ Hash

  Destroy a specific source.

Methods inherited from DataObject

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

Class Method Details

.collection(account: nil) ⇒ Hash

List sources

Examples:

Emarsys::Source.collection

Returns:

• (Hash) —

  List of sources

# File 'lib/emarsys/data_objects/source.rb', line 15

def collection(account: nil)
  get account, 'source', {}
end

.create(name:, account: nil) ⇒ Hash

Create a new source

Examples:

Emarsys::Source.create("My new source")

Parameters:

• name (String) —

  Name of the new source

Returns:

• (Hash) —

  Result data

# File 'lib/emarsys/data_objects/source.rb', line 25

def create(name:, account: nil)
  post account, 'source/create', {:name => name}
end

.destroy(id, account: nil) ⇒ Hash

Destroy a specific source

Examples:

Emarsys::Source.destroy(2)

Parameters:

• id (Integer, String) —

  The internal emarsys id

Returns:

• (Hash) —

  Result data

# File 'lib/emarsys/data_objects/source.rb', line 35

def destroy(id, account: nil)
  delete account, "source/#{id}", {}
end