bwapi 9.0.0.pre.390 → 9.0.0.pre.401
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
@@ -7,7 +7,7 @@ module BWAPI
|
|
7
7
|
# Get the events for an existing display
|
8
8
|
#
|
9
9
|
# @param [Integer] display_id The display id
|
10
|
-
# @return [
|
10
|
+
# @return [Hash] All events for display
|
11
11
|
def events(display_id)
|
12
12
|
get "commandcenter/displays/#{display_id}/events"
|
13
13
|
end
|
@@ -16,7 +16,7 @@ module BWAPI
|
|
16
16
|
#
|
17
17
|
# @param [Integer] display_id The display id
|
18
18
|
# @param [Integer] event_id The event id
|
19
|
-
# @return [
|
19
|
+
# @return [Hash] Specific event for display
|
20
20
|
def get_event(display_id, event_id)
|
21
21
|
get "commandcenter/displays/#{display_id}/events/#{event_id}"
|
22
22
|
end
|
@@ -36,7 +36,7 @@ module BWAPI
|
|
36
36
|
# @option opts [String] created Date event created
|
37
37
|
# @option opts [Boolean] enabled Whether event is enabled
|
38
38
|
# @option opts [Hash] filters Event filter options
|
39
|
-
# @return [
|
39
|
+
# @return [Hash] New display event
|
40
40
|
def create_event(display_id, opts = {})
|
41
41
|
post "commandcenter/displays/#{display_id}/events", opts
|
42
42
|
end
|
@@ -56,7 +56,7 @@ module BWAPI
|
|
56
56
|
# @option opts [String] created Date event created
|
57
57
|
# @option opts [Boolean] enabled Whether event is enabled
|
58
58
|
# @option opts [Hash] filters Event filter options
|
59
|
-
# @return [
|
59
|
+
# @return [Hash] Updated display event
|
60
60
|
def update_event(display_id, event_id, opts = {})
|
61
61
|
put "commandcenter/displays/#{display_id}/events/#{event_id}", opts
|
62
62
|
end
|
@@ -65,7 +65,7 @@ module BWAPI
|
|
65
65
|
#
|
66
66
|
# @param [Integer] display_id The display id
|
67
67
|
# @param [Integer] event_id The event id
|
68
|
-
# @return [
|
68
|
+
# @return [Hash] Deleted display event
|
69
69
|
def delete_event(display_id, event_id)
|
70
70
|
delete "commandcenter/displays/#{display_id}/events/#{event_id}"
|
71
71
|
end
|
@@ -7,7 +7,7 @@ module BWAPI
|
|
7
7
|
# Get the messages for an existing display
|
8
8
|
#
|
9
9
|
# @param [Integer] display_id The display id
|
10
|
-
# @return [
|
10
|
+
# @return [Hash] All messages for display
|
11
11
|
def messages(display_id)
|
12
12
|
get "commandcenter/displays/#{display_id}/messages"
|
13
13
|
end
|
@@ -16,7 +16,7 @@ module BWAPI
|
|
16
16
|
#
|
17
17
|
# @param [Integer] display_id The display id
|
18
18
|
# @param [Integer] message_id The message id
|
19
|
-
# @return [
|
19
|
+
# @return [Hash] Specific message for display
|
20
20
|
def get_message(display_id, message_id)
|
21
21
|
get "commandcenter/displays/#{display_id}/messages/#{message_id}"
|
22
22
|
end
|
@@ -34,7 +34,7 @@ module BWAPI
|
|
34
34
|
# @option opts [Boolean] active Whether message is active
|
35
35
|
# @option opts [Boolean] enabled Whether message is enabled
|
36
36
|
# @option opts [Array] screenIds ScreenIds where message is shown
|
37
|
-
# @return [
|
37
|
+
# @return [Hash] New display message
|
38
38
|
def create_message(display_id, opts = {})
|
39
39
|
post "commandcenter/displays/#{display_id}/message", opts
|
40
40
|
end
|
@@ -52,7 +52,7 @@ module BWAPI
|
|
52
52
|
# @option opts [Boolean] active Whether message is active
|
53
53
|
# @option opts [Boolean] enabled Whether message is enabled
|
54
54
|
# @option opts [Array] screenIds ScreenIds where message is shown
|
55
|
-
# @return [
|
55
|
+
# @return [Hash] Updated display message
|
56
56
|
def update_message(display_id, message_id, opts = {})
|
57
57
|
put "commandcenter/displays/#{display_id}/messages/#{message_id}", opts
|
58
58
|
end
|
@@ -61,7 +61,7 @@ module BWAPI
|
|
61
61
|
#
|
62
62
|
# @param [Integer] display_id The display id
|
63
63
|
# @param [Integer] message_id The message id
|
64
|
-
# @return [
|
64
|
+
# @return [Hash] Deleted display message
|
65
65
|
def delete_message(display_id, message_id)
|
66
66
|
delete "commandcenter/displays/#{display_id}/messages/#{message_id}"
|
67
67
|
end
|
@@ -7,7 +7,7 @@ module BWAPI
|
|
7
7
|
# Get the scenes for an existing display
|
8
8
|
#
|
9
9
|
# @param [Integer] display_id The display id
|
10
|
-
# @return [
|
10
|
+
# @return [Hash] All scenes for display
|
11
11
|
def scenes(display_id)
|
12
12
|
get "commandcenter/displays/#{display_id}/scenes"
|
13
13
|
end
|
@@ -16,7 +16,7 @@ module BWAPI
|
|
16
16
|
#
|
17
17
|
# @param [Integer] display_id The display id
|
18
18
|
# @param [Integer] scene_id The scene id
|
19
|
-
# @return [
|
19
|
+
# @return [Hash] Specific scene for display
|
20
20
|
def get_scene(display_id, scene_id)
|
21
21
|
get "commandcenter/displays/#{display_id}/scenes/#{scene_id}"
|
22
22
|
end
|
@@ -25,7 +25,7 @@ module BWAPI
|
|
25
25
|
#
|
26
26
|
# @param [Integer] display_id The display id
|
27
27
|
# @param [Integer] scene_id The scene id
|
28
|
-
# @return [
|
28
|
+
# @return [Hash] Specific sub scenes for display scene
|
29
29
|
def get_scene_with_sub_scenes(display_id, scene_id)
|
30
30
|
get "commandcenter/displays/#{display_id}/scenes/#{scene_id}/subscenes"
|
31
31
|
end
|
@@ -44,7 +44,7 @@ module BWAPI
|
|
44
44
|
# @option opts [String] created Date scene was created
|
45
45
|
# @option opts [Boolean] enabled Whether scene is enabled
|
46
46
|
# @option opts [Hash] filter Filter options
|
47
|
-
# @return [
|
47
|
+
# @return [Hash] New display scene
|
48
48
|
def create_scene(display_id, opts = {})
|
49
49
|
post "commandcenter/displays/#{display_id}/scenes", opts
|
50
50
|
end
|
@@ -63,7 +63,7 @@ module BWAPI
|
|
63
63
|
# @option opts [String] created Date scene was created
|
64
64
|
# @option opts [Boolean] enabled Whether scene is enabled
|
65
65
|
# @option opts [Hash] filter Filter options
|
66
|
-
# @return [
|
66
|
+
# @return [Hash] Updated display scene
|
67
67
|
def update_scene(display_id, scene_id, opts = {})
|
68
68
|
put "commandcenter/displays/#{display_id}/scenes/#{scene_id}", opts
|
69
69
|
end
|
@@ -72,7 +72,7 @@ module BWAPI
|
|
72
72
|
#
|
73
73
|
# @param [Integer] display_id The display id
|
74
74
|
# @param [Integer] scene_id The scene id
|
75
|
-
# @return [
|
75
|
+
# @return [Hash] Deleted display scene
|
76
76
|
def delete_scene(display_id, scene_id)
|
77
77
|
delete "commandcenter/displays/#{display_id}/scenes/#{scene_id}"
|
78
78
|
end
|
@@ -7,7 +7,7 @@ module BWAPI
|
|
7
7
|
# Get the screens for a display
|
8
8
|
#
|
9
9
|
# @param [Integer] display_id The display id
|
10
|
-
# @return [
|
10
|
+
# @return [Hash] All screens for display
|
11
11
|
def screens(display_id)
|
12
12
|
get "commandcenter/displays/#{display_id}/screens"
|
13
13
|
end
|
@@ -16,7 +16,7 @@ module BWAPI
|
|
16
16
|
#
|
17
17
|
# @param [Integer] display_id The display id
|
18
18
|
# @param [Integer] screen_id The screen id
|
19
|
-
# @return [
|
19
|
+
# @return [Hash] Specific screen for display
|
20
20
|
def get_screen(display_id, screen_id)
|
21
21
|
get "commandcenter/displays/#{display_id}/screens/#{screen_id}"
|
22
22
|
end
|
@@ -25,7 +25,7 @@ module BWAPI
|
|
25
25
|
#
|
26
26
|
# @param [Integer] display_id The display id
|
27
27
|
# @param [Integer] screen_id The screen id
|
28
|
-
# @return [
|
28
|
+
# @return [Hash] Specific screen for display with scenes
|
29
29
|
def get_screen_with_scenes(display_id, screen_id)
|
30
30
|
get "commandcenter/displays/#{display_id}/screens/#{screen_id}/withscenes"
|
31
31
|
end
|
@@ -41,7 +41,7 @@ module BWAPI
|
|
41
41
|
# @option opts [Array] screenIds Screen ids used to display
|
42
42
|
# @option opts [String] created Date screen was created
|
43
43
|
# @option opts [Boolean] enabled Whether screen is enabled
|
44
|
-
# @return [
|
44
|
+
# @return [Hash] New display screen
|
45
45
|
def create_screen(display_id, opts = {})
|
46
46
|
post "commandcenter/displays/#{display_id}/screens", opts
|
47
47
|
end
|
@@ -57,7 +57,7 @@ module BWAPI
|
|
57
57
|
# @option opts [Array] screenIds Screen ids used to display
|
58
58
|
# @option opts [String] created Date screen was created
|
59
59
|
# @option opts [Boolean] enabled Whether screen is enabled
|
60
|
-
# @return [
|
60
|
+
# @return [Hash] Updated display screen
|
61
61
|
def update_screen(display_id, screen_id, opts = {})
|
62
62
|
put "commandcenter/displays/#{display_id}/screens/#{screen_id}", opts
|
63
63
|
end
|
@@ -66,7 +66,7 @@ module BWAPI
|
|
66
66
|
#
|
67
67
|
# @param [Integer] display_id The display id
|
68
68
|
# @param [Integer] screen_id The screen id
|
69
|
-
# @return [
|
69
|
+
# @return [Hash] Deleted display screen
|
70
70
|
def delete_screen(display_id, screen_id)
|
71
71
|
delete "commandcenter/displays/#{display_id}/screens/#{screen_id}"
|
72
72
|
end
|
@@ -8,7 +8,7 @@ module BWAPI
|
|
8
8
|
module Users
|
9
9
|
# Get all users display access levels
|
10
10
|
#
|
11
|
-
# @return [
|
11
|
+
# @return [Hash] Display access levels
|
12
12
|
def displays_access_levels
|
13
13
|
get 'commandcenter/displays/users'
|
14
14
|
end
|
@@ -16,7 +16,7 @@ module BWAPI
|
|
16
16
|
# Get a users display access levels for displays
|
17
17
|
#
|
18
18
|
# @param [Integer] user_id the user id
|
19
|
-
# @return [
|
19
|
+
# @return [Hash] Specific display user access levels
|
20
20
|
def get_displays_user_access_levels(user_id)
|
21
21
|
get "commandcenter/displays/users/#{user_id}"
|
22
22
|
end
|
@@ -24,7 +24,7 @@ module BWAPI
|
|
24
24
|
# Get displays access levels for users
|
25
25
|
#
|
26
26
|
# @param [Integer] display_id the display id
|
27
|
-
# @return [
|
27
|
+
# @return [Hash] Specific display user access levels
|
28
28
|
def get_display_users_access_levels(display_id)
|
29
29
|
get "commandcenter/displays/#{display_id}/users"
|
30
30
|
end
|
@@ -33,7 +33,7 @@ module BWAPI
|
|
33
33
|
#
|
34
34
|
# @param [Integer] display_id the display id
|
35
35
|
# @param [Integer] user_id the user id
|
36
|
-
# @return [
|
36
|
+
# @return [Hash] Specific display and user access level
|
37
37
|
def get_display_user_access_levels(display_id, user_id)
|
38
38
|
get "commandcenter/displays/#{display_id}/users/#{user_id}"
|
39
39
|
end
|
@@ -42,7 +42,7 @@ module BWAPI
|
|
42
42
|
#
|
43
43
|
# @param [Integer] display_id the display id
|
44
44
|
# @param [Integer] user_id the user id
|
45
|
-
# @return [
|
45
|
+
# @return [Hash] Specific display and user access level
|
46
46
|
def delete_display_user_access_levels(display_id, user_id)
|
47
47
|
delete "commandcenter/displays/#{display_id}/users/#{user_id}"
|
48
48
|
end
|
@@ -10,7 +10,7 @@ module BWAPI
|
|
10
10
|
# @param [Integer] display_id the display id
|
11
11
|
# @param [Integer] user_id the user id
|
12
12
|
# @param [Integer] access_level the access level
|
13
|
-
# @return [
|
13
|
+
# @return [Hash] Updated user access level
|
14
14
|
def grant_display_user_access_level(display_id, user_id, access_level)
|
15
15
|
post "commandcenter/displays/#{display_id}/users/#{user_id}/access/#{access_level}"
|
16
16
|
end
|
@@ -20,7 +20,7 @@ module BWAPI
|
|
20
20
|
# @param [Integer] display_id the display id
|
21
21
|
# @param [Integer] user_id the user id
|
22
22
|
# @param [Integer] access_level the access level
|
23
|
-
# @return [
|
23
|
+
# @return [Hash] Updated user access level
|
24
24
|
def update_display_user_access_level(display_id, user_id, access_level)
|
25
25
|
put "commandcenter/displays/#{display_id}/users/#{user_id}/access/#{access_level}"
|
26
26
|
end
|
@@ -5,7 +5,7 @@ module BWAPI
|
|
5
5
|
module SceneTypes
|
6
6
|
# Get the scene types visible to the user
|
7
7
|
#
|
8
|
-
# @return [
|
8
|
+
# @return [Hash] All scene types
|
9
9
|
def scene_types
|
10
10
|
get 'commandcenter/scenetypes'
|
11
11
|
end
|
@@ -13,7 +13,7 @@ module BWAPI
|
|
13
13
|
# Get an existing scene type
|
14
14
|
#
|
15
15
|
# @param [Integer] scene_type_id the scene type id
|
16
|
-
# @return [
|
16
|
+
# @return [Hash] Specific scene type
|
17
17
|
def get_scene_type(scene_type_id)
|
18
18
|
get "commandcenter/scenetypes/#{scene_type_id}"
|
19
19
|
end
|
@@ -21,7 +21,7 @@ module BWAPI
|
|
21
21
|
# Get an existing scene type
|
22
22
|
#
|
23
23
|
# @param [Integer] scene_type_id the scene type id
|
24
|
-
# @return [
|
24
|
+
# @return [Hash] Specific scene type with sub scences
|
25
25
|
def get_scene_type_with_sub_scenes(scene_type_id)
|
26
26
|
get "commandcenter/scenetypes/#{scene_type_id}"
|
27
27
|
end
|
@@ -7,7 +7,7 @@ module BWAPI
|
|
7
7
|
module Users
|
8
8
|
# Get the access levels for all users
|
9
9
|
#
|
10
|
-
# @return [
|
10
|
+
# @return [Hash] All users access levels
|
11
11
|
def users_access_levels
|
12
12
|
get 'commandcenter/users'
|
13
13
|
end
|
@@ -15,7 +15,7 @@ module BWAPI
|
|
15
15
|
# Get an existing user access level
|
16
16
|
#
|
17
17
|
# @param [Integer] user_id the user id
|
18
|
-
# @return [
|
18
|
+
# @return [Hash] Specific user access level
|
19
19
|
def get_user_access_level(user_id)
|
20
20
|
get "commandcenter/users/#{user_id}"
|
21
21
|
end
|
@@ -23,7 +23,7 @@ module BWAPI
|
|
23
23
|
# Delete an existing user access level
|
24
24
|
#
|
25
25
|
# @param [Integer] user_id the user id
|
26
|
-
# @return [
|
26
|
+
# @return [Hash] Deleted user access level
|
27
27
|
def delete_user_access_level(user_id)
|
28
28
|
delete "commandcenter/users/#{user_id}"
|
29
29
|
end
|
@@ -8,7 +8,7 @@ module BWAPI
|
|
8
8
|
#
|
9
9
|
# @param [Integer] user_id the user id
|
10
10
|
# @param [Integer] access_level the access level
|
11
|
-
# @return [
|
11
|
+
# @return [Hash] Updated user access level
|
12
12
|
def update_user_access_level(user_id, access_level)
|
13
13
|
put "commandcenter/users/#{user_id}/access/#{access_level}"
|
14
14
|
end
|
data/lib/bwapi/client/filters.rb
CHANGED
@@ -4,7 +4,7 @@ module BWAPI
|
|
4
4
|
module Locations
|
5
5
|
# Request the information for a given location code
|
6
6
|
#
|
7
|
-
# @return [
|
7
|
+
# @return [Hash] Information about the location
|
8
8
|
def location(location_code)
|
9
9
|
get "locations/#{location_code}"
|
10
10
|
end
|
@@ -15,7 +15,7 @@ module BWAPI
|
|
15
15
|
# @option opts [Array] a list of location types to return
|
16
16
|
# @option opts [Integer] page number of results to retrieve
|
17
17
|
# @option opts [Integer] pageSize of the results to retrieve
|
18
|
-
# @return [
|
18
|
+
# @return [Hash] The list of matching locations
|
19
19
|
def locations(opts = {})
|
20
20
|
get 'locations', opts
|
21
21
|
end
|
data/lib/bwapi/client/logout.rb
CHANGED
data/lib/bwapi/client/me.rb
CHANGED
data/lib/bwapi/client/metrics.rb
CHANGED
data/lib/bwapi/client/ping.rb
CHANGED
@@ -4,35 +4,35 @@ module BWAPI
|
|
4
4
|
module Ping
|
5
5
|
# Get ping checking access and available HTTP verbs
|
6
6
|
#
|
7
|
-
# @return [
|
7
|
+
# @return [Hash] User id and name
|
8
8
|
def get_ping
|
9
9
|
get 'ping'
|
10
10
|
end
|
11
11
|
|
12
12
|
# Post ping checking access and available HTTP verbs
|
13
13
|
#
|
14
|
-
# @return [
|
14
|
+
# @return [Hash] User id and name
|
15
15
|
def create_ping
|
16
16
|
post 'ping'
|
17
17
|
end
|
18
18
|
|
19
19
|
# Put ping checking access and available HTTP verbs
|
20
20
|
#
|
21
|
-
# @return [
|
21
|
+
# @return [Hash] User id and name
|
22
22
|
def update_ping
|
23
23
|
put 'ping'
|
24
24
|
end
|
25
25
|
|
26
26
|
# Patch ping checking access and available HTTP verbs
|
27
27
|
#
|
28
|
-
# @return [
|
28
|
+
# @return [Hash] User id and name
|
29
29
|
def patch_ping
|
30
30
|
patch 'ping'
|
31
31
|
end
|
32
32
|
|
33
33
|
# Delete ping checking access and available HTTP verbs
|
34
34
|
#
|
35
|
-
# @return [
|
35
|
+
# @return [Hash] User id and name
|
36
36
|
def delete_ping
|
37
37
|
delete 'ping'
|
38
38
|
end
|