Module: BWAPI

Extended by:
Configuration
Defined in:
lib/bwapi.rb,
lib/bwapi/error.rb,
lib/bwapi/client.rb,
lib/bwapi/default.rb,
lib/bwapi/request.rb,
lib/bwapi/version.rb,
lib/bwapi/client/me.rb,
lib/bwapi/client/sso.rb,
lib/bwapi/connection.rb,
lib/bwapi/client/ping.rb,
lib/bwapi/client/user.rb,
lib/bwapi/performance.rb,
lib/bwapi/client/admin.rb,
lib/bwapi/client/oauth.rb,
lib/bwapi/client/author.rb,
lib/bwapi/client/client.rb,
lib/bwapi/client/logout.rb,
lib/bwapi/client/public.rb,
lib/bwapi/configuration.rb,
lib/bwapi/client/filters.rb,
lib/bwapi/client/metrics.rb,
lib/bwapi/response/error.rb,
lib/bwapi/client/projects.rb,
lib/bwapi/response/logger.rb,
lib/bwapi/client/languages.rb,
lib/bwapi/client/locations.rb,
lib/bwapi/client/aggregates.rb,
lib/bwapi/client/brandwatch.rb,
lib/bwapi/client/dimensions.rb,
lib/bwapi/client/error_codes.rb,
lib/bwapi/client/test_search.rb,
lib/bwapi/client/user/tokens.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/projects/data.rb,
lib/bwapi/client/projects/tags.rb,
lib/bwapi/client/user/facebook.rb,
lib/bwapi/response/performance.rb,
lib/bwapi/client/admin/projects.rb,
lib/bwapi/client/admin/reseller.rb,
lib/bwapi/client/command_center.rb,
lib/bwapi/client/projects/group.rb,
lib/bwapi/client/projects/rules.rb,
lib/bwapi/client/projects/users.rb,
lib/bwapi/client/projects/alerts.rb,
lib/bwapi/client/projects/queries.rb,
lib/bwapi/client/projects/sharing.rb,
lib/bwapi/client/projects/signals.rb,
lib/bwapi/client/projects/summary.rb,
lib/bwapi/client/query_validation.rb,
lib/bwapi/client/brandwatch/become.rb,
lib/bwapi/client/projects/workflow.rb,
lib/bwapi/client/admin/demographics.rb,
lib/bwapi/client/brandwatch/clients.rb,
lib/bwapi/client/client/grant_types.rb,
lib/bwapi/client/client/sub_clients.rb,
lib/bwapi/client/projects/data/urls.rb,
lib/bwapi/client/user/notifications.rb,
lib/bwapi/client/admin/clients/users.rb,
lib/bwapi/client/projects/categories.rb,
lib/bwapi/client/projects/rules/copy.rb,
lib/bwapi/client/brandwatch/log_level.rb,
lib/bwapi/client/command_center/users.rb,
lib/bwapi/client/projects/data/volume.rb,
lib/bwapi/client/command_center/client.rb,
lib/bwapi/client/command_center/themes.rb,
lib/bwapi/client/projects/bulk_actions.rb,
lib/bwapi/client/projects/demographics.rb,
lib/bwapi/client/projects/queries/move.rb,
lib/bwapi/client/projects/query_groups.rb,
lib/bwapi/client/admin/pricing_upgrades.rb,
lib/bwapi/client/client/pricing_options.rb,
lib/bwapi/client/projects/data/audience.rb,
lib/bwapi/client/projects/data/hashtags.rb,
lib/bwapi/client/projects/data/mentions.rb,
lib/bwapi/client/projects/data_download.rb,
lib/bwapi/client/projects/ditto_queries.rb,
lib/bwapi/client/brandwatch/ditto_brands.rb,
lib/bwapi/client/brandwatch/usage_report.rb,
lib/bwapi/client/command_center/displays.rb,
lib/bwapi/client/command_center/projects.rb,
lib/bwapi/client/projects/data/emoticons.rb,
lib/bwapi/client/projects/data/headlines.rb,
lib/bwapi/client/projects/preview_search.rb,
lib/bwapi/client/projects/rules/backfill.rb,
lib/bwapi/client/projects/signals/groups.rb,
lib/bwapi/client/brandwatch/clients/users.rb,
lib/bwapi/client/projects/categories/copy.rb,
lib/bwapi/client/projects/twitter_queries.rb,
lib/bwapi/client/user/twitter_credentials.rb,
lib/bwapi/client/admin/clients/user_groups.rb,
lib/bwapi/client/brandwatch/command_center.rb,
lib/bwapi/client/projects/data/impressions.rb,
lib/bwapi/client/projects/facebook_queries.rb,
lib/bwapi/client/projects/group/site_group.rb,
lib/bwapi/client/projects/queries/backfill.rb,
lib/bwapi/client/projects/queries/mentions.rb,
lib/bwapi/client/brandwatch/clients/modules.rb,
lib/bwapi/client/command_center/scene_types.rb,
lib/bwapi/client/command_center/tag_colours.rb,
lib/bwapi/client/projects/query/mentionfind.rb,
lib/bwapi/client/projects/stream_dashboards.rb,
lib/bwapi/client/user/instagram_credentials.rb,
lib/bwapi/client/admin/clients/users/sharing.rb,
lib/bwapi/client/brandwatch/price_structures.rb,
lib/bwapi/client/command_center/users/access.rb,
lib/bwapi/client/projects/group/author_group.rb,
lib/bwapi/client/projects/queries/date_range.rb,
lib/bwapi/client/command_center/projects/data.rb,
lib/bwapi/client/command_center/query_colours.rb,
lib/bwapi/client/projects/bulk_actions/author.rb,
lib/bwapi/client/projects/data/mentions/notes.rb,
lib/bwapi/client/projects/data/owner_activity.rb,
lib/bwapi/client/command_center/colour_palette.rb,
lib/bwapi/client/command_center/display_access.rb,
lib/bwapi/client/command_center/displays/users.rb,
lib/bwapi/client/projects/data/channel_metrics.rb,
lib/bwapi/client/projects/group/location_group.rb,
lib/bwapi/client/brandwatch/clients/grant_types.rb,
lib/bwapi/client/command_center/displays/events.rb,
lib/bwapi/client/command_center/displays/scenes.rb,
lib/bwapi/client/projects/bulk_actions/mentions.rb,
lib/bwapi/client/command_center/category_colours.rb,
lib/bwapi/client/command_center/displays/screens.rb,
lib/bwapi/client/projects/data/audience_activity.rb,
lib/bwapi/client/projects/data/mentioned_authors.rb,
lib/bwapi/client/brandwatch/command_center/themes.rb,
lib/bwapi/client/command_center/displays/messages.rb,
lib/bwapi/client/brandwatch/clients/command_center.rb,
lib/bwapi/client/brandwatch/host_location_overrides.rb,
lib/bwapi/client/projects/stream_dashboards/streams.rb,
lib/bwapi/client/brandwatch/price_structures/clients.rb,
lib/bwapi/client/command_center/display_access/users.rb,
lib/bwapi/client/command_center/projects/tag_colours.rb,
lib/bwapi/client/command_center/displays/users/access.rb,
lib/bwapi/client/brandwatch/command_center/scene_types.rb,
lib/bwapi/client/brandwatch/clients/command_center/users.rb,
lib/bwapi/client/brandwatch/clients/command_center/limits.rb,
lib/bwapi/client/brandwatch/clients/command_center/themes.rb,
lib/bwapi/client/command_center/projects/category_colours.rb,
lib/bwapi/client/command_center/display_access/users/access.rb,
lib/bwapi/client/brandwatch/clients/command_center/scene_types.rb,
lib/bwapi/client/brandwatch/clients/command_center/users/access.rb

Overview

BWAPI Version

Defined Under Namespace

Modules: Configuration, Connection, Default, Performance, Request, Response Classes: BWError, BadGateway, BadRequest, Client, Forbidden, InternalServerError, NotAcceptable, NotFound, NotImplemented, ServiceUnavailable, TooManyRequests, Unauthorized, UnprocessableEntity

Constant Summary collapse

VERSION = 
'12.0.0'

Instance Attribute Summary

Attributes included from Configuration

#access_token, #access_token_expiry, #adapter, #api_endpoint, #client_id, #debug, #grant_type, #logger, #performance, #refresh_token, #user_agent, #username, #verify_ssl

Class Method Summary collapse

Methods included from Configuration

configure, destroy, keys, reset

Class Method Details

.new(opts = {}) ⇒ BWAPI::Client

Alias for BWAPI::Client.new

Returns:



12
13
14
 
# File 'lib/bwapi.rb', line 12

def new(opts = {})
  BWAPI::Client.new(opts)
end

.respond_to?(method_name, include_private = false) ⇒ Boolean

Check BWAPI::Client.new responds

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/bwapi.rb', line 17

def respond_to?(method_name, include_private = false)
  new.respond_to?(method_name, include_private) || super
end