Class: Vonage::Conversations::Events

Inherits:
Namespace
  • Object
show all
Defined in:
lib/vonage/conversations/events.rb

Instance Method Summary collapse

Instance Method Details

#create(conversation_id, params) ⇒ Response

Deprecated.

Please use Vonage::Conversation::Event#create instead

Create an event.

Parameters:

  • conversation_id (String)
  • params (Hash)

Options Hash (params):

  • :type (required, String) —

    Event type.

  • :to (String) —

    Member ID.

  • :from (required, String) —

    Member ID.

  • :body (Hash) —

    Event Body.

Returns:

See Also:



33
34
35
36
 
# File 'lib/vonage/conversations/events.rb', line 33

def create(conversation_id, params)
  logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Event#create` instead.')
  request('/beta/conversations/' + conversation_id + '/events', params: params, type: Post)
end

#delete(conversation_id, event_id) ⇒ Response

Deprecated.

Please use Vonage::Conversation::Event#delete instead

Delete an event.

Parameters:

  • conversation_id (String)
  • event_id (String)

Returns:

See Also:



84
85
86
87
 
# File 'lib/vonage/conversations/events.rb', line 84

def delete(conversation_id, event_id)
  logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Event#delete` instead.')
  request('/beta/conversations/' + conversation_id + '/events/' + event_id.to_s, type: Delete)
end

#get(conversation_id, event_id) ⇒ Response

Deprecated.

Please use Vonage::Conversation::Event#find instead

Retrieve an event.

Parameters:

  • conversation_id (String)
  • event_id (String)

Returns:

See Also:



68
69
70
71
 
# File 'lib/vonage/conversations/events.rb', line 68

def get(conversation_id, event_id)
  logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Event#find` instead.')
  request('/beta/conversations/' + conversation_id + '/events/' + event_id.to_s)
end

#list(conversation_id, params = nil, auto_advance = true) ⇒ Response

Deprecated.

Please use Vonage::Conversation::Event#list instead

List events.

Parameters:

  • conversation_id (String)
  • params (Hash) (defaults to: nil) —

    a customizable set of options

Options Hash (params):

  • :auto_advance (Boolean) —

    Set this to ‘false` to not auto-advance through all the pages in the record and collect all the data. The default is `true`.

Returns:

See Also:



52
53
54
55
 
# File 'lib/vonage/conversations/events.rb', line 52

def list(conversation_id, params = nil, auto_advance = true)
  logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Event#list` instead.')
  request('/beta/conversations/' + conversation_id + '/events', params: params)
end