bwapi 9.0.0.pre.390 → 9.0.0.pre.401
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +8 -8
- data/CHANGELOG.md +18 -0
- data/CONTRIBUTING.md +14 -0
- data/README.md +30 -34
- data/bwapi.gemspec +1 -1
- data/lib/bwapi/client/admin.rb +2 -2
- data/lib/bwapi/client/admin/become.rb +1 -1
- data/lib/bwapi/client/admin/search.rb +3 -3
- data/lib/bwapi/client/admin/sub_clients.rb +5 -5
- data/lib/bwapi/client/admin/users.rb +4 -4
- data/lib/bwapi/client/admin/users/sharing.rb +2 -2
- data/lib/bwapi/client/brandwatch.rb +1 -1
- data/lib/bwapi/client/brandwatch/become.rb +1 -1
- data/lib/bwapi/client/brandwatch/client_modules.rb +2 -2
- data/lib/bwapi/client/client.rb +2 -2
- data/lib/bwapi/client/command_center/client.rb +1 -1
- data/lib/bwapi/client/command_center/displays.rb +5 -5
- data/lib/bwapi/client/command_center/displays/events.rb +5 -5
- data/lib/bwapi/client/command_center/displays/messages.rb +5 -5
- data/lib/bwapi/client/command_center/displays/scenes.rb +6 -6
- data/lib/bwapi/client/command_center/displays/screens.rb +6 -6
- data/lib/bwapi/client/command_center/displays/users.rb +5 -5
- data/lib/bwapi/client/command_center/displays/users/access.rb +2 -2
- data/lib/bwapi/client/command_center/scene_types.rb +3 -3
- data/lib/bwapi/client/command_center/themes.rb +1 -1
- data/lib/bwapi/client/command_center/users.rb +3 -3
- data/lib/bwapi/client/command_center/users/access.rb +1 -1
- data/lib/bwapi/client/error_codes.rb +1 -1
- data/lib/bwapi/client/filters.rb +1 -1
- data/lib/bwapi/client/languages.rb +1 -1
- data/lib/bwapi/client/locations.rb +2 -2
- data/lib/bwapi/client/logout.rb +1 -1
- data/lib/bwapi/client/me.rb +1 -1
- data/lib/bwapi/client/metrics.rb +1 -1
- data/lib/bwapi/client/ping.rb +5 -5
- data/lib/bwapi/client/projects.rb +5 -5
- data/lib/bwapi/client/projects/bulkactions.rb +1 -1
- data/lib/bwapi/client/projects/bulkactions/author.rb +1 -1
- data/lib/bwapi/client/projects/bulkactions/mentions.rb +1 -1
- data/lib/bwapi/client/projects/categories.rb +4 -4
- data/lib/bwapi/client/projects/categories/copy.rb +1 -1
- data/lib/bwapi/client/projects/data.rb +2 -2
- data/lib/bwapi/client/projects/data/mentions.rb +4 -4
- data/lib/bwapi/client/projects/data/mentions/notes.rb +4 -4
- data/lib/bwapi/client/projects/data/volume.rb +1 -1
- data/lib/bwapi/client/projects/data_download.rb +3 -3
- data/lib/bwapi/client/projects/demographics.rb +1 -1
- data/lib/bwapi/client/projects/facebook_queries.rb +5 -5
- data/lib/bwapi/client/projects/group/author_group.rb +5 -5
- data/lib/bwapi/client/projects/group/location_group.rb +5 -5
- data/lib/bwapi/client/projects/group/site_group.rb +5 -5
- data/lib/bwapi/client/projects/queries.rb +6 -6
- data/lib/bwapi/client/projects/queries/backfill.rb +4 -4
- data/lib/bwapi/client/projects/queries/date_range.rb +5 -5
- data/lib/bwapi/client/projects/queries/mentions.rb +3 -3
- data/lib/bwapi/client/projects/query_groups.rb +5 -5
- data/lib/bwapi/client/projects/rules.rb +5 -5
- data/lib/bwapi/client/projects/rules/backfill.rb +1 -1
- data/lib/bwapi/client/projects/rules/copy.rb +1 -1
- data/lib/bwapi/client/projects/sharing.rb +5 -5
- data/lib/bwapi/client/projects/signals.rb +1 -1
- data/lib/bwapi/client/projects/signals/groups.rb +5 -5
- data/lib/bwapi/client/projects/stream_dashboards.rb +6 -6
- data/lib/bwapi/client/projects/stream_dashboards/streams.rb +5 -5
- data/lib/bwapi/client/projects/summary.rb +1 -1
- data/lib/bwapi/client/projects/tags.rb +5 -5
- data/lib/bwapi/client/projects/twitter_queries.rb +4 -4
- data/lib/bwapi/client/projects/users.rb +1 -1
- data/lib/bwapi/client/projects/workflow.rb +1 -1
- data/lib/bwapi/client/query_validation.rb +2 -2
- data/lib/bwapi/client/sso.rb +1 -1
- data/lib/bwapi/client/test_search.rb +1 -1
- data/lib/bwapi/client/user.rb +2 -2
- data/lib/bwapi/client/user/notifications.rb +4 -4
- data/lib/bwapi/request.rb +6 -6
- metadata +5 -3
checksums.yaml
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
---
|
2
2
|
!binary "U0hBMQ==":
|
3
3
|
metadata.gz: !binary |-
|
4
|
-
|
4
|
+
OTI1MjNmMWIzNjJlYjc5NzU3MTkwYWZjNWZmYjg4MTkzM2FkZDdjZg==
|
5
5
|
data.tar.gz: !binary |-
|
6
|
-
|
6
|
+
YTNlZWMzYzU3Mjk4OWY0ZDgwYWI0MDNjNzFmODY0YmQxMzg2MGY0Ng==
|
7
7
|
SHA512:
|
8
8
|
metadata.gz: !binary |-
|
9
|
-
|
10
|
-
|
11
|
-
|
9
|
+
Y2I3MDc4Yzk0NjE1NGFmZDljYTVhMzE1MDhmYjgyYmYxZWZkODMyYzc3NzAy
|
10
|
+
MGM4NGRkYTQ4ZTZhNTg1YzZmMThiNDJlYmZkOTA4N2E3ZjdlMTNiM2Y1ZTgz
|
11
|
+
ODE4OWEyMGNhOWZlZTIxNmQ5MzNlZGFlNTc2Yzg4ZmFjMzBmZDA=
|
12
12
|
data.tar.gz: !binary |-
|
13
|
-
|
14
|
-
|
15
|
-
|
13
|
+
ZjQ3MmQ2MDJhY2NlYmE4ZTZmYjJkZDY1YmJkNzJlMDkyNTg3Y2NiNTE0NWI0
|
14
|
+
YjFlNTY5MzU1NjE1ZjRlYjQ1ODQ4MDNiMzg0YjU0YTQ2ODJjNjhjZTBkNWY3
|
15
|
+
YTMxMTg1ODhjNjMyNGJiNjc3NDJlNDRlNGE1MDJmOWNmMDY3NTE=
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# Changelog
|
2
|
+
All notable changes to this project will be documented in this file.
|
3
|
+
|
4
|
+
## 9.0.0
|
5
|
+
### Added
|
6
|
+
* NoTask - updated notifications endpoints to match new structure
|
7
|
+
* NoTask - refactored configuration and defaults classes
|
8
|
+
* NoTask - removed hashie middleware in favour of OJ for improved performance
|
9
|
+
* NoTask - Implemented signals groups endpoints
|
10
|
+
* NoTask - Implemented mention notes endpoints
|
11
|
+
* #112 - Create logger middleware
|
12
|
+
* #113 - Create performance middleware
|
13
|
+
* #129 - Update README.md following latest updates
|
14
|
+
* #130 - Add separate CONTRIBUTING.md and CHANGELOG.md
|
15
|
+
* #133 - Updated method comments to return Hash instead of Hashie::Mash
|
16
|
+
|
17
|
+
### Fixed
|
18
|
+
* NoTask - remove unwanted opts from mentions note get request
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# Contributing
|
2
|
+
|
3
|
+
If you would like to contribute to this project please fork the repo and follow the guidelines below:
|
4
|
+
|
5
|
+
1. Create an issue outlining the feature or bug
|
6
|
+
2. Once approved/confirmed create a new branch from the staging branch
|
7
|
+
3. Once your feature has been implemented ensure:
|
8
|
+
* Exisiting RSpec unit tests still pass
|
9
|
+
* No [Rubocop](https://github.com/bbatsov/rubocop) offenses have been introduced
|
10
|
+
4. Create a new pull request merging into the staging branch (unit and rubocop tests will automatically run on travis)
|
11
|
+
5. Update PR if the code reviewer returns comments or tests fail in step above
|
12
|
+
6. Once merged the gem version + gemspec date will be updated and merged into the master branch
|
13
|
+
7. Travis will create a pre release gem on any merge into the master branch
|
14
|
+
8. Once the pre release gem is tested and approved the new gem version will be pushed to rubygems
|
data/README.md
CHANGED
@@ -5,16 +5,13 @@
|
|
5
5
|
[![Coverage Status](https://coveralls.io/repos/jonathanchrisp/bwapi/badge.png?branch=master)](https://coveralls.io/r/jonathanchrisp/bwapi?branch=master)
|
6
6
|
|
7
7
|
# bwapi
|
8
|
-
|
9
|
-
__PLEASE NOTE THAT THIS PROJECT IS NOT OFFICIALLY SUPPORTED BY BRANDWATCH__
|
10
|
-
|
11
|
-
A Ruby interface to the Brandwatch V2 API.
|
8
|
+
A Ruby interface to the Brandwatch API.
|
12
9
|
|
13
10
|
## Documentation
|
14
11
|
http://rubydoc.info/gems/bwapi/
|
15
12
|
|
16
13
|
## Getting Started
|
17
|
-
All Brandwatch API calls at present require you to be authenticated, therefore you'll need to create an instance of a client and call login immediately:
|
14
|
+
All Brandwatch API calls at present require you to be authenticated, therefore you'll need to create an instance of a bwapi client and call the login method immediately:
|
18
15
|
|
19
16
|
```ruby
|
20
17
|
bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd')
|
@@ -24,35 +21,35 @@ bw.login
|
|
24
21
|
The API returns the oauth/token response with your authentication details.
|
25
22
|
|
26
23
|
## Examples
|
24
|
+
Once authenticated, you are then able to make additional requests. The bwapi gem will automatically add your access token to subsequent request headers.
|
27
25
|
|
28
|
-
|
26
|
+
Please see an example projects response below:
|
29
27
|
|
30
|
-
### Request all projects
|
31
28
|
```ruby
|
32
29
|
bw.projects
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
=>
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
30
|
+
{
|
31
|
+
"resultsTotal"=>-1,
|
32
|
+
"resultsPage"=>-1,
|
33
|
+
"resultsPageSize"=>-1,
|
34
|
+
"results"=>[
|
35
|
+
{ "id"=>1856280126,
|
36
|
+
"name"=>"Demo Project",
|
37
|
+
"description"=>nil,
|
38
|
+
"clientId"=>1856278873,
|
39
|
+
"defaultLangCodes"=>["en"],
|
40
|
+
"defaultIndustry"=>"general-(recommended)",
|
41
|
+
"creatorUserId"=>158304410,
|
42
|
+
"creationDate"=>"2013-07-24T17:56:31.074+0000",
|
43
|
+
"links"=> {
|
44
|
+
"queries"=>"http://newapi.brandwatch.com//projects/1856280126/queries.json?access_token=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
45
|
+
},
|
46
|
+
"clientName"=>"JC BWAPI Demo"
|
47
|
+
}
|
48
|
+
]
|
49
|
+
}
|
52
50
|
```
|
53
51
|
|
54
52
|
## Debug Mode
|
55
|
-
|
56
53
|
In order to see additional logging and performance information you can enable debug mode by passing this in as an option when creating your client instance:
|
57
54
|
|
58
55
|
```ruby
|
@@ -60,7 +57,6 @@ bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd', d
|
|
60
57
|
```
|
61
58
|
|
62
59
|
### Logging
|
63
|
-
|
64
60
|
Any log output will be written to STDOUT unless you define a logger:
|
65
61
|
|
66
62
|
```ruby
|
@@ -68,20 +64,20 @@ bw = BWAPI::Client.new(username: 'username@example.com', password: 'pa$$w0rd', d
|
|
68
64
|
```
|
69
65
|
|
70
66
|
### Performance
|
71
|
-
|
72
|
-
When debug mode is running each response time and stored, to view the stats call the performance method on the client instance:
|
67
|
+
When debug mode is running the response performance is stored on each require, to view the stats call the performance method on the client instance:
|
73
68
|
|
74
69
|
```ruby
|
75
70
|
bw.performance
|
76
|
-
{
|
71
|
+
{
|
72
|
+
"post_oauth_token"=>[0.125019],
|
73
|
+
"get_me"=> [0.048003, 0.034587, 0.038165, 0.10304]
|
74
|
+
}
|
77
75
|
```
|
78
76
|
|
79
77
|
Please note that only successful responses are recorded. Any request which raises an error is ignored.
|
80
78
|
|
81
79
|
## Contributing
|
82
|
-
If you would like to contribute to this project please
|
83
|
-
|
84
|
-
Once the staging branch is merged into master a pre-release gem will automatically be created via travis. Subject to no issues being found the new version of the gem will be pushed to RubyGems.
|
80
|
+
If you would like to contribute to this project please see the [contributing guidelines](https://github.com/jonathanchrisp/bwapi/blob/staging/CONTRIBUTING.md).
|
85
81
|
|
86
82
|
## Tests
|
87
83
|
There are a number of unit tests which are included as part of this project, please run:
|
data/bwapi.gemspec
CHANGED
@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
|
|
4
4
|
s.name = 'bwapi'
|
5
5
|
s.version = BWAPI::VERSION
|
6
6
|
s.version = BWAPI::VERSION + ".pre.#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
|
7
|
-
s.date = '2014-08-
|
7
|
+
s.date = '2014-08-28'
|
8
8
|
s.summary = 'Brandwatch API Wrapper'
|
9
9
|
s.description = 'A Ruby wrapper for the Brandwatch API'
|
10
10
|
s.author = 'Jonathan Chrisp'
|
data/lib/bwapi/client/admin.rb
CHANGED
@@ -13,14 +13,14 @@ module BWAPI
|
|
13
13
|
# @option opts [Integer] page Page of projects to retrieve
|
14
14
|
# @option opts [Integer] pageSize Results per page of results
|
15
15
|
# @option opts [Integer] sortBy Filter to sort queries by
|
16
|
-
# @return [
|
16
|
+
# @return [Hash] All active queries
|
17
17
|
def active_queries(opts = {})
|
18
18
|
get 'admin/activequeries', opts
|
19
19
|
end
|
20
20
|
|
21
21
|
# Get the project report of sharing details
|
22
22
|
#
|
23
|
-
# @return [
|
23
|
+
# @return [Hash] Project sharing report
|
24
24
|
def sharing_report
|
25
25
|
get 'admin/sharing-report'
|
26
26
|
end
|
@@ -8,7 +8,7 @@ module BWAPI
|
|
8
8
|
#
|
9
9
|
# @param opts [Hash] options hash of parameters
|
10
10
|
# @option opts [Integer] text Text expression
|
11
|
-
# @return [
|
11
|
+
# @return [Hash] List of queries
|
12
12
|
def search_query_text(opts = {})
|
13
13
|
get 'admin/search/querytext', opts
|
14
14
|
end
|
@@ -17,7 +17,7 @@ module BWAPI
|
|
17
17
|
#
|
18
18
|
# @param opts [Hash] options hash of parameters
|
19
19
|
# @option opts [Integer] text Text expression
|
20
|
-
# @return [
|
20
|
+
# @return [Hash] List of query names
|
21
21
|
def search_query_name(opts = {})
|
22
22
|
get 'admin/search/queryname', opts
|
23
23
|
end
|
@@ -26,7 +26,7 @@ module BWAPI
|
|
26
26
|
#
|
27
27
|
# @param opts [Hash] options hash of parameters
|
28
28
|
# @option opts [Integer] text Text expression
|
29
|
-
# @return [
|
29
|
+
# @return [Hash] List of rules
|
30
30
|
def search_rule_text(opts = {})
|
31
31
|
get 'admin/search/ruletext', opts
|
32
32
|
end
|
@@ -10,7 +10,7 @@ module BWAPI
|
|
10
10
|
# @param opts [Hash] options hash of parameters
|
11
11
|
# @option opts [Integer] page Page of projects to retrieve
|
12
12
|
# @option opts [Integer] pageSize Results per page of results
|
13
|
-
# @return [
|
13
|
+
# @return [Hash] All sub clients for client
|
14
14
|
def client_sub_clients(client_id, opts = {})
|
15
15
|
get "admin/clients/#{client_id}/subclients", opts
|
16
16
|
end
|
@@ -19,7 +19,7 @@ module BWAPI
|
|
19
19
|
#
|
20
20
|
# @param client_id [Integer] Id of the client
|
21
21
|
# @param sub_client_id [Integer] Id of the sub client
|
22
|
-
# @return [
|
22
|
+
# @return [Hash] Specific sub client for client
|
23
23
|
def get_client_sub_client(client_id, sub_client_id)
|
24
24
|
get "admin/clients/#{client_id}/subclients/#{sub_client_id}"
|
25
25
|
end
|
@@ -54,7 +54,7 @@ module BWAPI
|
|
54
54
|
# @option opts [String] contactName The contact name of the client
|
55
55
|
# @option opts [Integer] maximumSubscribedBrands The maximum subscribed brands for the client
|
56
56
|
# @option opts [String] contactMobile The mobile number for the client
|
57
|
-
# @return [
|
57
|
+
# @return [Hash] New sub client
|
58
58
|
def create_client_sub_client(client_id, opts = {})
|
59
59
|
post "admin/clients/#{client_id}/subclients", opts
|
60
60
|
end
|
@@ -90,7 +90,7 @@ module BWAPI
|
|
90
90
|
# @option opts [String] contactName The contact name of the client
|
91
91
|
# @option opts [Integer] maximumSubscribedBrands The maximum subscribed brands for the client
|
92
92
|
# @option opts [String] contactMobile The mobile number for the client
|
93
|
-
# @return [
|
93
|
+
# @return [Hash] Edited sub client
|
94
94
|
def update_client_sub_client(client_id, sub_client_id, opts = {})
|
95
95
|
put "admin/clients/#{client_id}/subclients/#{sub_client_id}", opts
|
96
96
|
end
|
@@ -99,7 +99,7 @@ module BWAPI
|
|
99
99
|
#
|
100
100
|
# @param client_id [Integer] Id of the client
|
101
101
|
# @param sub_client_id [Integer] Id of the sub client
|
102
|
-
# @return [
|
102
|
+
# @return [Hash] Specific sub client for client
|
103
103
|
def delete_client_sub_client(client_id, sub_client_id)
|
104
104
|
delete "admin/clients/#{client_id}/subclients/#{sub_client_id}"
|
105
105
|
end
|
@@ -12,7 +12,7 @@ module BWAPI
|
|
12
12
|
# @param opts [Hash] options hash of parameters
|
13
13
|
# @option opts [Integer] page Page of projects to retrieve
|
14
14
|
# @option opts [Integer] pageSize Results per page of results
|
15
|
-
# @return [
|
15
|
+
# @return [Hash] All client users
|
16
16
|
def client_users(client_id, opts = {})
|
17
17
|
get "admin/clients/#{client_id}/users", opts
|
18
18
|
end
|
@@ -21,7 +21,7 @@ module BWAPI
|
|
21
21
|
#
|
22
22
|
# @param client_id [Integer] Id of the client
|
23
23
|
# @param user_id [Integer] Id of the user
|
24
|
-
# @return [
|
24
|
+
# @return [Hash] Specific client user
|
25
25
|
def get_client_user(client_id, user_id)
|
26
26
|
get "admin/clients/#{client_id}/users/#{user_id}"
|
27
27
|
end
|
@@ -48,7 +48,7 @@ module BWAPI
|
|
48
48
|
# @option opts [String] firstName The users first name
|
49
49
|
# @option opts [String] mobile The users mobile number
|
50
50
|
# @option opts [Date] creationDate Date the user was created on
|
51
|
-
# @return [
|
51
|
+
# @return [Hash] New user
|
52
52
|
def create_client_user(client_id, opts = {})
|
53
53
|
post "admin/clients/#{client_id}/users", opts
|
54
54
|
end
|
@@ -76,7 +76,7 @@ module BWAPI
|
|
76
76
|
# @option opts [String] firstName The users first name
|
77
77
|
# @option opts [String] mobile The users mobile number
|
78
78
|
# @option opts [Date] creationDate Date the user was created on
|
79
|
-
# @return [
|
79
|
+
# @return [Hash] New user
|
80
80
|
def update_client_user(client_id, user_id, opts = {})
|
81
81
|
put "admin/clients/#{client_id}/users/#{user_id}", opts
|
82
82
|
end
|
@@ -9,7 +9,7 @@ module BWAPI
|
|
9
9
|
#
|
10
10
|
# @param client_id [Integer] Id of the client
|
11
11
|
# @param user_id [Integer] Id of the user
|
12
|
-
# @return [
|
12
|
+
# @return [Hash] All shares for client user
|
13
13
|
def client_users_sharing(client_id, user_id)
|
14
14
|
get "admin/client/#{client_id}/users/#{user_id}/sharing"
|
15
15
|
end
|
@@ -20,7 +20,7 @@ module BWAPI
|
|
20
20
|
# @param user_id [Integer] Id of the user
|
21
21
|
# @param opts [Hash] options Hash of parameters
|
22
22
|
# @option opts [Array] ProjectShareDTO The shares of the user
|
23
|
-
# @return [
|
23
|
+
# @return [Hash] Updated shares for client user
|
24
24
|
def update_client_users_sharing(client_id, user_id, opts)
|
25
25
|
get "admin/client/#{client_id}/users/#{user_id}/sharing", opts
|
26
26
|
end
|
@@ -19,7 +19,7 @@ module BWAPI
|
|
19
19
|
# @option opts [String] downloadLinkXLS The link to download the XLS format
|
20
20
|
# @option opts [String] downloadLinkCSV The link to download the CSV format
|
21
21
|
# @option opts [Array] additionalColumns The additional columns for the data download
|
22
|
-
# @return [
|
22
|
+
# @return [Hash] New data download
|
23
23
|
def brandwatch_data_download(project_id, opts = {})
|
24
24
|
post "brandwatch/#{project_id}/datadownload", opts
|
25
25
|
end
|
@@ -6,7 +6,7 @@ module BWAPI
|
|
6
6
|
# Get a specific clients modules
|
7
7
|
#
|
8
8
|
# @param client_id [Integer] Id of the client
|
9
|
-
# @return [
|
9
|
+
# @return [Hash] Specific clients modules
|
10
10
|
def brandwatch_client_modules(client_id)
|
11
11
|
get "brandwatch/clientModules/#{client_id}"
|
12
12
|
end
|
@@ -15,7 +15,7 @@ module BWAPI
|
|
15
15
|
#
|
16
16
|
# @param opts [Hash] options Hash of parameters
|
17
17
|
# @option opts [Array] ClientModules Client Modules to edit
|
18
|
-
# @return [
|
18
|
+
# @return [Hash] Update client modules
|
19
19
|
def update_brandwatch_client_module(opts = {})
|
20
20
|
put 'brandwatch/clientModules', opts
|
21
21
|
end
|
data/lib/bwapi/client/client.rb
CHANGED
@@ -4,14 +4,14 @@ module BWAPI
|
|
4
4
|
module Client
|
5
5
|
# Get the current users client
|
6
6
|
#
|
7
|
-
# @return [
|
7
|
+
# @return [Hash] Client information
|
8
8
|
def client
|
9
9
|
get 'client'
|
10
10
|
end
|
11
11
|
|
12
12
|
# Get the current users client modules
|
13
13
|
#
|
14
|
-
# @return [
|
14
|
+
# @return [Hash] Client module information
|
15
15
|
def client_modules
|
16
16
|
get 'client/modules'
|
17
17
|
end
|
@@ -11,7 +11,7 @@ module BWAPI
|
|
11
11
|
module Displays
|
12
12
|
# Get the displays visible to the user
|
13
13
|
#
|
14
|
-
# @return [
|
14
|
+
# @return [Hash] All displays
|
15
15
|
def displays
|
16
16
|
get 'commandcenter/displays'
|
17
17
|
end
|
@@ -19,7 +19,7 @@ module BWAPI
|
|
19
19
|
# Get an existing display
|
20
20
|
#
|
21
21
|
# @param [Integer] display_id the display id
|
22
|
-
# @return [
|
22
|
+
# @return [Hash] Specific display
|
23
23
|
def get_display(display_id)
|
24
24
|
get "commandcenter/displays/#{display_id}"
|
25
25
|
end
|
@@ -34,7 +34,7 @@ module BWAPI
|
|
34
34
|
# @option opts [Boolean] active Whether display is active
|
35
35
|
# @option opts [String] created Date display was created
|
36
36
|
# @option opts [Boolean] enabled Whether display is enabled
|
37
|
-
# @return [
|
37
|
+
# @return [Hash] New display
|
38
38
|
def create_display(opts = {})
|
39
39
|
post 'commandcenter/displays', opts
|
40
40
|
end
|
@@ -50,7 +50,7 @@ module BWAPI
|
|
50
50
|
# @option opts [Boolean] active Whether display is active
|
51
51
|
# @option opts [String] created Date display was created
|
52
52
|
# @option opts [Boolean] enabled Whether display is enabled
|
53
|
-
# @return [
|
53
|
+
# @return [Hash] Updated display
|
54
54
|
def update_display(display_id, opts = {})
|
55
55
|
put "commandcenter/displays/#{display_id}", opts
|
56
56
|
end
|
@@ -58,7 +58,7 @@ module BWAPI
|
|
58
58
|
# Delete an existing display
|
59
59
|
#
|
60
60
|
# @param [Integer] display_id the display id
|
61
|
-
# @return [
|
61
|
+
# @return [Hash] Deleted display
|
62
62
|
def delete_display(display_id)
|
63
63
|
delete "commandcenter/displays/#{display_id}"
|
64
64
|
end
|