Class: BWAPI::Client

Inherits:

Object

• Object
• BWAPI::Client

Includes:

Authentication, Admin, Brandwatch, Client, CommandCenter, ErrorCodes, Filters, Languages, Location, Logout, Me, Metrics, OAuth, Ping, Projects, QueryValidation, SSO, TestSearch, User, Connection, Request

Defined in:

lib/bwapi/client.rb,
lib/bwapi/client/me.rb,
lib/bwapi/client/sso.rb,
lib/bwapi/client/ping.rb,
lib/bwapi/client/user.rb,
lib/bwapi/client/admin.rb,
lib/bwapi/client/oauth.rb,
lib/bwapi/client/client.rb,
lib/bwapi/client/logout.rb,
lib/bwapi/client/filters.rb,
lib/bwapi/client/metrics.rb,
lib/bwapi/client/location.rb,
lib/bwapi/client/projects.rb,
lib/bwapi/client/languages.rb,
lib/bwapi/client/brandwatch.rb,
lib/bwapi/client/admin/users.rb,
lib/bwapi/client/error_codes.rb,
lib/bwapi/client/test_search.rb,
lib/bwapi/client/admin/become.rb,
lib/bwapi/client/admin/search.rb,
lib/bwapi/client/projects/data.rb,
lib/bwapi/client/projects/tags.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/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/admin/sub_clients.rb,
lib/bwapi/client/brandwatch/become.rb,
lib/bwapi/client/projects/workflow.rb,
lib/bwapi/client/user/notifications.rb,
lib/bwapi/client/admin/users/sharing.rb,
lib/bwapi/client/projects/categories.rb,
lib/bwapi/client/projects/rules/copy.rb,
lib/bwapi/client/command_center/users.rb,
lib/bwapi/client/projects/bulkactions.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/demographics.rb,
lib/bwapi/client/projects/query_groups.rb,
lib/bwapi/client/projects/data/mentions.rb,
lib/bwapi/client/projects/data_download.rb,
lib/bwapi/client/command_center/displays.rb,
lib/bwapi/client/projects/rules/backfill.rb,
lib/bwapi/client/projects/twitter_queries.rb,
lib/bwapi/client/brandwatch/client_modules.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/command_center/scene_types.rb,
lib/bwapi/client/projects/stream_dashboards.rb,
lib/bwapi/client/command_center/users/access.rb,
lib/bwapi/client/projects/bulkactions/author.rb,
lib/bwapi/client/projects/group/author_group.rb,
lib/bwapi/client/projects/queries/date_range.rb,
lib/bwapi/client/command_center/displays/users.rb,
lib/bwapi/client/projects/bulkactions/mentions.rb,
lib/bwapi/client/projects/group/location_group.rb,
lib/bwapi/client/command_center/displays/events.rb,
lib/bwapi/client/command_center/displays/scenes.rb,
lib/bwapi/client/command_center/displays/screens.rb,
lib/bwapi/client/command_center/displays/messages.rb,
lib/bwapi/client/projects/stream_dashboards/streams.rb,
lib/bwapi/client/command_center/displays/users/access.rb

Overview

Client class to create BWAPI instances

Defined Under Namespace

Modules: Admin, Brandwatch, Client, CommandCenter, ErrorCodes, Filters, Languages, Location, Logout, Me, Metrics, OAuth, Ping, Projects, QueryValidation, SSO, TestSearch, User

Instance Method Summary

• #initialize(opts = {}) ⇒ Client constructor

  A new instance of Client.

Methods included from User

#api_role, #ui_role, #update_user, #user

Methods included from User::Notifications

#delete_notification, #notifications, #update_notification

Methods included from TestSearch

#test_search_content

Methods included from QueryValidation

#query_validation, #search_within

Methods included from SSO

#sso

Methods included from Projects

#create_project, #delete_project, #get_project, #projects, #update_project

Methods included from Projects::Workflow

#workflow

Methods included from Projects::Users

#project_users

Methods included from Projects::Tags

#create_tag, #delete_tag, #get_tag, #tags, #update_tag

Methods included from Projects::Rules

#create_rule, #delete_rule, #get_rule, #rules, #update_rule

Methods included from Projects::Rules::Copy

#create_rule_copy

Methods included from Projects::Rules::Backfill

#create_rule_backfill

Methods included from Projects::QueryGroups

#create_query_group, #delete_query_group, #get_query_group, #query_groups, #update_query_group

Methods included from Projects::Queries

#create_query, #delete_query, #get_query, #queries, #queries_summary, #update_query

Methods included from Projects::Queries::Mentions

#delete_query_mention, #get_query_mention_content, #update_query_mention

Methods included from Projects::Queries::DateRange

#create_date_range, #date_ranges, #delete_date_range, #get_date_range, #update_date_range

Methods included from Projects::Queries::Backfill

#backfills, #create_backfill, #delete_backfill, #get_backfill

Methods included from Projects::StreamDashboards

#create_stream_dashboard, #delete_stream_dashboard, #get_stream_dashboard, #get_stream_dashboard_complete, #get_stream_dashboards_summary, #stream_dashboards, #update_stream_dashboard

Methods included from Projects::StreamDashboards::Streams

#create_stream, #delete_stream, #get_stream, #get_streams, #update_stream

Methods included from Projects::Sharing

#default_project_sharing, #project_sharing, #project_sharing_user, #update_project_sharing, #update_project_sharing_user

Methods included from Projects::Summary

#projects_summary

Methods included from Projects::Signals

#set_signal_vote, #signals

Methods included from Projects::TwitterQueries

#create_twitter_query, #get_twitter_query, #twitter_queries, #update_twitter_query

Methods included from Projects::Group::SiteGroup

#create_site_group, #delete_site_group, #get_site_group, #site_groups_summary, #update_site_group

Methods included from Projects::Group::LocationGroup

#create_location_group, #delete_location_group, #get_location_group, #location_groups_summary, #update_location_group

Methods included from Projects::Group::AuthorGroup

#author_groups_summary, #create_author_group, #delete_author_group, #get_author_group, #update_author_group

Methods included from Projects::FacebookQueries

#authorise_facebook_queries, #create_facebook_query, #facebook_queries, #get_facebook_query, #update_facebook_query

Methods included from Projects::Demographics

#demographics

Methods included from Projects::DataDownload

#create_data_download, #data_downloads, #get_data_download

Methods included from Projects::Data

#data, #data_headlines

Methods included from Projects::Data::Volume

#data_volume_date_ranges_days, #data_volume_queries_top_sites, #data_volume_top_authors_queries, #data_volume_top_authors_queries_alt, #data_volume_top_sites_queries, #data_volume_top_tweeters_queries, #data_volume_topics_compare, #data_volume_topics_queries

Methods included from Projects::Data::Mentions

#data_mentions, #data_mentions_fulltext, #data_mentions_tweets, #update_data_mentions

Methods included from Projects::Categories

#categories, #create_category, #delete_category, #update_category

Methods included from Projects::BulkActions

#bulk_actions

Methods included from Projects::BulkActions::Author

#bulk_edit_author

Methods included from Projects::BulkActions::Mentions

#bulk_edit_mentions

Methods included from Ping

#create_ping, #delete_ping, #get_ping, #patch_ping, #update_ping

Methods included from OAuth

#determine_grant_type, #oauth_refresh_token, #oauth_request, #oauth_token

Methods included from Metrics

#metrics

Methods included from Me

#client_id, #client_name, #me, #user_id

Methods included from Logout

#logout

Methods included from Location

#location, #location_autocomplete

Methods included from Languages

#languages

Methods included from Filters

#filters

Methods included from ErrorCodes

#error_codes

Methods included from CommandCenter::Users

#delete_user_access_level, #get_user_access_level, #users_access_levels

Methods included from CommandCenter::Users::Access

#update_user_access_level

Methods included from CommandCenter::Themes

#themes

Methods included from CommandCenter::SceneTypes

#get_scene_type, #get_scene_type_with_sub_scenes, #scene_types

Methods included from CommandCenter::Displays

#create_display, #delete_display, #displays, #get_display, #update_display

Methods included from CommandCenter::Displays::Users

#delete_display_user_access_levels, #displays_access_levels, #get_display_user_access_levels, #get_display_users_access_levels, #get_displays_user_access_levels

Methods included from CommandCenter::Displays::Users::Access

#grant_display_user_access_level, #update_display_user_access_level

Methods included from CommandCenter::Displays::Screens

#create_screen, #delete_screen, #get_screen, #get_screen_with_scenes, #screens, #update_screen

Methods included from CommandCenter::Displays::Scenes

#create_scene, #delete_scene, #get_scene, #get_scene_with_sub_scenes, #scenes, #update_scene

Methods included from CommandCenter::Displays::Messages

#create_message, #delete_message, #get_message, #messages, #update_message

Methods included from CommandCenter::Displays::Events

#create_event, #delete_event, #events, #get_event, #update_event

Methods included from CommandCenter::Client

#vizia_client

Methods included from Client

#client, #client_modules

Methods included from Brandwatch

#brandwatch_data_download

Methods included from Brandwatch::ClientModules

#brandwatch_client_modules, #update_brandwatch_client_module

Methods included from Brandwatch::Become

#brandwatch_become

Methods included from Admin

#active_queries, #sharing_report

Methods included from Admin::Clients::Users

#client_users, #create_client_user, #get_client_user, #update_client_user

Methods included from Admin::Clients::Users::Sharing

#client_users_sharing, #update_client_users_sharing

Methods included from Admin::Clients::Search

#search_query_name, #search_query_text, #search_rule_text

Methods included from Admin::Clients::SubClients

#client_sub_clients, #create_client_sub_client, #delete_client_sub_client, #get_client_sub_client, #update_client_sub_client

Methods included from Admin::Clients::Become

#admin_become

Methods included from Request

#delete, #get, #patch, #post, #put

Methods included from Authentication

#api_client?, #application_client?, #authenticated?, #netrc_credentials

Constructor Details

#initialize(opts = {}) ⇒ Client

Returns a new instance of Client.

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

def initialize(opts = {})
  opts = BWAPI.options.merge opts
  Configuration::OPTION_KEYS.each do |k|
    send "#{k}=", opts[k]
  end

  netrc_credentials opts[:netrc]
end