Module: BWAPI::Client::Admin::Clients

Includes:

UserGroups, Users

Included in:

BWAPI::Client::Admin

Defined in:

lib/bwapi/client/admin/clients.rb,
lib/bwapi/client/admin/clients/users.rb,
lib/bwapi/client/admin/clients/user_groups.rb,
lib/bwapi/client/admin/clients/users/sharing.rb

Overview

Clients module for admin/clients endpoints

Defined Under Namespace

Modules: UserGroups, Users

Instance Method Summary

• #daily_usage(client_id, opts = {}) ⇒ Object

  Retrieve the daily usage for the given client.

• #login_report(client_id, opts = {}) ⇒ Object

  Retrieve the login count for users for the given client.

Methods included from UserGroups

#client_user_groups, #create_client_user_group, #delete_client_user_group, #update_client_user_group

Methods included from Users

#client_users, #create_client_user, #get_client_user, #update_client_user

Methods included from Users::Sharing

#client_users_sharing, #update_client_users_sharing

Instance Method Details

#daily_usage(client_id, opts = {}) ⇒ Object

Retrieve the daily usage for the given client

TODO: Add parameters documentation

# File 'lib/bwapi/client/admin/clients.rb', line 19

def daily_usage(client_id, opts = {})
  get "admin/clients/#{client_id}/usage/daily", opts
end

#login_report(client_id, opts = {}) ⇒ Object

Retrieve the login count for users for the given client

TODO: Add parameters documentation

# File 'lib/bwapi/client/admin/clients.rb', line 12

def login_report(client_id, opts = {})
  get "admin/clients/#{client_id}/login-report", opts
end