Class: Zype::Users

Inherits:
BaseModel show all
Defined in:
lib/zype/models/users.rb

Overview

Read more at docs.zype.com/v1.0/reference#users. This class does not support the delete method.

Since:

  • 0.13.0

Constant Summary

Constants inherited from BaseModel

BaseModel::ACCEPTED_KEYS

Instance Attribute Summary

Attributes inherited from BaseModel

#client

Instance Method Summary collapse

Methods inherited from BaseModel

#all, #auth=, #create, #delete, #find, #initialize, #update

Constructor Details

This class inherits a constructor from Zype::BaseModel

Instance Method Details

#remove(id:) ⇒ Hash

Remove a user from a site property. This does not delete the user. Read more at docs.zype.com/v1.0/reference#removeuser

Parameters:

  • id (String) —

    the ID of the user

Returns:

  • (Hash) —

    the user object

Since:

  • 0.13.0



18
19
20
 
# File 'lib/zype/models/users.rb', line 18

def remove(id:)
  client.execute(method: :put, path: "/#{path}/#{id}/remove")
end