Class: Vonage::Conversations::Users

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

Instance Method Summary collapse

Instance Method Details

#create(params) ⇒ Response

Deprecated.

Please use Users#create instead

Create a user.

Parameters:

  • params (Hash)

Options Hash (params):

  • :name (String) —

    Unique name for a user.

  • :display_name (String) —

    A string to be displayed as user name. It does not need to be unique.

  • :image_url (String) —

    A link to an image for conversations’ and users’ avatars.

Returns:

See Also:



30
31
32
33
 
# File 'lib/vonage/conversations/users.rb', line 30

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

#delete(id) ⇒ Response

Deprecated.

Please use Users#delete instead

Delete a user.

Parameters:

  • id (String)

Returns:

See Also:



107
108
109
110
 
# File 'lib/vonage/conversations/users.rb', line 107

def delete(id)
  logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Users#delete` instead.')
  request('/beta/users/' + id, type: Delete)
end

#get(id) ⇒ Response

Deprecated.

Please use Users#find instead

Retrieve a user.

Parameters:

  • id (String)

Returns:

See Also:



62
63
64
65
 
# File 'lib/vonage/conversations/users.rb', line 62

def get(id)
  logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Users#find` instead.')
  request('/beta/users/' + id)
end

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

Deprecated.

Please use Users#list instead

List users.

Parameters:

  • 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:



47
48
49
50
 
# File 'lib/vonage/conversations/users.rb', line 47

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

#update(id, params) ⇒ Response

Deprecated.

Please use Users#update instead

Update a user.

Parameters:

  • id (String)
  • params (Hash)

Options Hash (params):

  • :name (String) —

    Unique name for a user.

  • :display_name (String) —

    A string to be displayed as user name. It does not need to be unique.

  • :image_url (String) —

    A link to an image for conversations’ and users’ avatars.

  • :channels (Hash) —

    A user who joins a conversation as a member can have one channel per membership type. Channels can be ‘app`, `phone`, `sip`, `websocket`, or `vbc`.

Returns:

See Also:



92
93
94
95
 
# File 'lib/vonage/conversations/users.rb', line 92

def update(id, params)
  logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Users#update` instead.')
  request('/beta/users/' + id, params: params, type: Put)
end