Module: BWAPI::Client::Admin

Includes:
Become, Client, Clients, Demographics, Integrations, PricingUpgrades, Projects, Reseller, Search
Included in:
BWAPI::Client
Defined in:
lib/bwapi/client/admin.rb,
lib/bwapi/client/admin/become.rb,
lib/bwapi/client/admin/client.rb,
lib/bwapi/client/admin/search.rb,
lib/bwapi/client/admin/clients.rb,
lib/bwapi/client/admin/projects.rb,
lib/bwapi/client/admin/reseller.rb,
lib/bwapi/client/admin/demographics.rb,
lib/bwapi/client/admin/integrations.rb,
lib/bwapi/client/admin/clients/users.rb,
lib/bwapi/client/admin/pricing_upgrades.rb,
lib/bwapi/client/admin/clients/user_groups.rb,
lib/bwapi/client/admin/clients/users/sharing.rb

Overview

Admin module for admin endpoints

Defined Under Namespace

Modules: Become, Client, Clients, Demographics, Integrations, PricingUpgrades, Projects, Reseller, Search

Instance Method Summary collapse

Methods included from Projects

#lock_query, #unlock_query

Methods included from PricingUpgrades

#pricing_upgrades

Methods included from Search

#search_query_name, #search_query_text, #search_rule_text

Methods included from Reseller

#reseller_client_mention_usage_report, #reseller_mention_usage_report

Methods included from Integrations

#create_jwt_integration, #get_jwt_integrations

Methods included from Demographics

#classify_author

Methods included from Client

#usage_by_query

Methods included from Clients

#daily_usage, #login_report

Methods included from Clients::UserGroups

#client_user_groups, #create_client_user_group, #delete_client_user_group, #update_client_user_group

Methods included from Clients::Users

#client_users, #create_client_user, #get_client_user, #update_client_user

Methods included from Clients::Users::Sharing

#client_users_sharing, #update_client_users_sharing

Methods included from Become

#admin_become

Instance Method Details

#active_queries(opts = {}) ⇒ Hash

Get the active queries irrespective of project

Parameters:

  • opts (Hash) (defaults to: {}) —

    options hash of parameters

Options Hash (opts):

  • page (Integer) —

    Page of projects to retrieve

  • pageSize (Integer) —

    Results per page of results

  • sortBy (Integer) —

    Filter to sort queries by

Returns:

  • (Hash) —

    All active queries



22
23
24
 
# File 'lib/bwapi/client/admin.rb', line 22

def active_queries(opts = {})
  get 'admin/activequeries', opts
end

#sharing_report ⇒ Hash

Get the project report of sharing details

Returns:

  • (Hash) —

    Project sharing report



29
30
31
 
# File 'lib/bwapi/client/admin.rb', line 29

def sharing_report
  get 'admin/sharing-report'
end