Class: ReamazeAPI::Contact

Inherits:

Resource

• Object
• Resource
• ReamazeAPI::Contact

Defined in:

lib/reamaze_api/contact.rb

Instance Method Summary

• #all(params = {}) ⇒ Object

  Retrieve contacts.

• #create(params) ⇒ Object

  Create a new contact.

• #update(slug, params) ⇒ Object

  Update an existing contact.

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from ReamazeAPI::Resource

Instance Method Details

#all(params = {}) ⇒ Object

Retrieve contacts.

Parameters:

• params (defaults to: {}) —

  Hash of parameters to pass to the API

• API —

  Routes GET /contacts

• See —

  also: www.reamaze.com/api/get_contacts

Returns:

• a Hash.

# File 'lib/reamaze_api/contact.rb', line 14

def all(params = {})
  paginate "/contacts", :contacts, params
end

#create(params) ⇒ Object

Create a new contact.

Parameters:

• params —

  Hash of parameters to pass to the API

• API —

  Routes POST /contacts

• See —

  also: www.reamaze.com/api/post_contacts

Returns:

• a Hash.

# File 'lib/reamaze_api/contact.rb', line 29

def create(params)
  post "/contacts", params
end

#update(slug, params) ⇒ Object

Update an existing contact.

Parameters:

• slug —

  Contact slug (email)

• params —

  Hash of parameters to pass to the API

• API —

  Routes PUT /contacts/slug

• See —

  also: www.reamaze.com/api/put_contacts

Returns:

• a Hash.

# File 'lib/reamaze_api/contact.rb', line 45

def update(slug, params)
  put "/contacts/#{slug}", params
end