Class: ReamazeAPI::Conversation

Inherits:

Resource

• Object
• Resource
• ReamazeAPI::Conversation

Defined in:

lib/reamaze_api/conversation.rb

Instance Method Summary

• #all(params = {}) ⇒ Object

  Retrieve conversations.

• #create(params) ⇒ Object

  Create a new conversation (on behalf of a customer).

• #find(slug) ⇒ Object

  Retrieve a specific conversation.

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from ReamazeAPI::Resource

Instance Method Details

#all(params = {}) ⇒ Object

Retrieve conversations.

Parameters:

• params (defaults to: {}) —

  Hash of parameters to pass to the API

• API —

  Routes GET /conversations

• See —

  also: www.reamaze.com/api/get_conversations

Returns:

• a Hash.

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

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

#create(params) ⇒ Object

Create a new conversation (on behalf of a customer).

Parameters:

• params —

  Hash of parameters to pass to the API

• API —

  Routes POST /conversations

• See —

  also: www.reamaze.com/api/post_conversations

Returns:

• a Hash.

# File 'lib/reamaze_api/conversation.rb', line 44

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

#find(slug) ⇒ Object

Retrieve a specific conversation.

Parameters:

• slug —

  Conversation slug

• API —

  Routes GET /conversations/slug

• See —

  also: www.reamaze.com/api/get_conversation

Returns:

• a Hash.

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

def find(slug)
  get "/conversations/#{slug}"
end