Class: BrickFTP::RESTfulAPI::ListUsers
- Inherits:
-
Object
- Object
- BrickFTP::RESTfulAPI::ListUsers
- Includes:
- Command
- Defined in:
- lib/brick_ftp/restful_api/list_users.rb
Overview
List users
Params
PARAMETER | TYPE | DESCRIPTION |
---|---|---|
page | integer | Optional page number of items to return in this request. Default: 1. |
per_page | integer | Optional requested number of items returned per request. Default: 1000. Leave blank for default (strongly recommended). |
Instance Method Summary collapse
-
#call(page: nil, per_page: nil) ⇒ Array<BrickFTP::Types::User>
Returns a list of users on the current site.
Methods included from Command
Instance Method Details
#call(page: nil, per_page: nil) ⇒ Array<BrickFTP::Types::User>
Returns a list of users on the current site.
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/brick_ftp/restful_api/list_users.rb', line 28 def call(page: nil, per_page: nil) validate_page!(page) validate_per_page!(per_page) params = {} params[:page] = page if page params[:per_page] = per_page if per_page query = params.map { |k, v| "#{k}=#{v}" }.join('&') endpoint = '/api/rest/v1/users.json' endpoint = "#{endpoint}?#{query}" unless query.empty? res = client.get(endpoint) res.map { |i| BrickFTP::Types::User.new(**i.symbolize_keys) } end |