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
@@ -11,7 +11,7 @@ module BWAPI
|
|
11
11
|
# @param opts [Hash] options hash of parameters
|
12
12
|
# @option opts [Integer] page Page of results to retrieve
|
13
13
|
# @option opts [Integer] pageSize Results per page
|
14
|
-
# @return [
|
14
|
+
# @return [Hash] All backfills for query
|
15
15
|
def backfills(project_id, query_id, opts = {})
|
16
16
|
get "projects/#{project_id}/queries/#{query_id}/backfill", opts
|
17
17
|
end
|
@@ -21,7 +21,7 @@ module BWAPI
|
|
21
21
|
# @param project_id [Integer] Id of project
|
22
22
|
# @param query_id [Integer] Id of query
|
23
23
|
# @param backfill_id [Integer] Id of backfill
|
24
|
-
# @return [
|
24
|
+
# @return [Hash] Backfill for query
|
25
25
|
def get_backfill(project_id, query_id, backfill_id)
|
26
26
|
get "projects/#{project_id}/queries/#{query_id}/backfill/#{backfill_id}"
|
27
27
|
end
|
@@ -40,7 +40,7 @@ module BWAPI
|
|
40
40
|
# @option opts [String] status Status of backfill
|
41
41
|
# @option opts [Integer] queryId Query id of backfill
|
42
42
|
# @option opts [String] statusMessages Current status message of backfill
|
43
|
-
# @return [
|
43
|
+
# @return [Hash] New backfill for query
|
44
44
|
def create_backfill(project_id, query_id, opts = {})
|
45
45
|
post "projects/#{project_id}/queries/#{query_id}/backfill", opts
|
46
46
|
end
|
@@ -50,7 +50,7 @@ module BWAPI
|
|
50
50
|
# @param project_id [Integer] Id of project
|
51
51
|
# @param query_id [Integer] Id of query
|
52
52
|
# @param backfill_id [Integer] Id of backfill
|
53
|
-
# @return [
|
53
|
+
# @return [Hash] Deleted backfill for query
|
54
54
|
def delete_backfill(project_id, query_id, backfill_id)
|
55
55
|
delete "projects/#{project_id}/queries/#{query_id}/backfill/#{backfill_id}"
|
56
56
|
end
|
@@ -8,7 +8,7 @@ module BWAPI
|
|
8
8
|
#
|
9
9
|
# @param project_id [Integer] Id of project
|
10
10
|
# @param query_id [Integer] Id of query
|
11
|
-
# @return [
|
11
|
+
# @return [Hash] All date ranges for query
|
12
12
|
def date_ranges(project_id, query_id)
|
13
13
|
get "projects/#{project_id}/queries/#{query_id}/date-range"
|
14
14
|
end
|
@@ -18,7 +18,7 @@ module BWAPI
|
|
18
18
|
# @param project_id [Integer] Id of project
|
19
19
|
# @param query_id [Integer] Id of query
|
20
20
|
# @param date_range_id [Integer] Id of date range
|
21
|
-
# @return [
|
21
|
+
# @return [Hash] Specific date range for query
|
22
22
|
def get_date_range(project_id, query_id, date_range_id)
|
23
23
|
get "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}"
|
24
24
|
end
|
@@ -31,7 +31,7 @@ module BWAPI
|
|
31
31
|
# @option opts [Integer] projectId Id of the project
|
32
32
|
# @option opts [Integer] queryId Id of the query
|
33
33
|
# @option opts [Array] StoredDateRangeDTO Date ranges to be stored
|
34
|
-
# @return [
|
34
|
+
# @return [Hash] New date range
|
35
35
|
def create_date_range(project_id, query_id, opts = {})
|
36
36
|
post "projects/#{project_id}/queries/#{query_id}/date-range", opts
|
37
37
|
end
|
@@ -46,7 +46,7 @@ module BWAPI
|
|
46
46
|
# @option opts [Integer] queryId Id of the query
|
47
47
|
# @option opts [Integer] dateRangeId Id of the date range
|
48
48
|
# @option opts [Array] StoredDateRangeDTO Date ranges to be edited
|
49
|
-
# @return [
|
49
|
+
# @return [Hash] Update date range
|
50
50
|
def update_date_range(project_id, query_id, date_range_id, opts = {})
|
51
51
|
put "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}", opts
|
52
52
|
end
|
@@ -56,7 +56,7 @@ module BWAPI
|
|
56
56
|
# @param project_id [Integer] Id of project
|
57
57
|
# @param query_id [Integer] Id of query
|
58
58
|
# @param date_range_id [Integer] Id of date range
|
59
|
-
# @return [
|
59
|
+
# @return [Hash] Deleted date range
|
60
60
|
def delete_date_range(project_id, query_id, date_range_id)
|
61
61
|
delete "projects/#{project_id}/queries/#{query_id}/date-range/#{date_range_id}"
|
62
62
|
end
|
@@ -9,7 +9,7 @@ module BWAPI
|
|
9
9
|
# @param project_id [Integer] Id of project
|
10
10
|
# @param query_id [Integer] Id of query
|
11
11
|
# @param mention_id [Integer] Id of mention
|
12
|
-
# @return [
|
12
|
+
# @return [Hash] Content of query mention
|
13
13
|
def get_query_mention_content(project_id, query_id, mention_id)
|
14
14
|
get "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}/content"
|
15
15
|
end
|
@@ -24,7 +24,7 @@ module BWAPI
|
|
24
24
|
# @option opts [Integer] queryId Id of the query
|
25
25
|
# @option opts [Integer] id Id of the mention
|
26
26
|
# @option opts [Hash] MentionPatchDTO patch to be applied
|
27
|
-
# @return [
|
27
|
+
# @return [Hash] Updated query mention
|
28
28
|
def update_query_mention(project_id, query_id, mention_id, opts = {})
|
29
29
|
patch "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}", opts
|
30
30
|
end
|
@@ -39,7 +39,7 @@ module BWAPI
|
|
39
39
|
# @option opts [Integer] queryId Id of the query
|
40
40
|
# @option opts [Integer] id Id of the mention
|
41
41
|
# @option opts [Hash] Map patch to be applied
|
42
|
-
# @return [
|
42
|
+
# @return [Hash] Deleted query mention
|
43
43
|
def delete_query_mention(project_id, query_id, mention_id, opts = {})
|
44
44
|
delete "projects/#{project_id}/queries/#{query_id}/mentions/#{mention_id}", opts
|
45
45
|
end
|
@@ -8,7 +8,7 @@ module BWAPI
|
|
8
8
|
# @param project_id [Integer] Id of project
|
9
9
|
# @option opts [Integer] page Page of projects to retrieve
|
10
10
|
# @option opts [Integer] pageSize Results per page of results
|
11
|
-
# @return [
|
11
|
+
# @return [Hash] All query groups in project
|
12
12
|
def query_groups(project_id, opts = {})
|
13
13
|
get "projects/#{project_id}/querygroups", opts
|
14
14
|
end
|
@@ -17,7 +17,7 @@ module BWAPI
|
|
17
17
|
#
|
18
18
|
# @param project_id [Integer] Id of project
|
19
19
|
# @param query_group_id [Integer] Id of query group
|
20
|
-
# @return [
|
20
|
+
# @return [Hash] Specific query group
|
21
21
|
def get_query_group(project_id, query_group_id)
|
22
22
|
get "projects/#{project_id}/querygroups/#{query_group_id}"
|
23
23
|
end
|
@@ -32,7 +32,7 @@ module BWAPI
|
|
32
32
|
# @option opts [Array] users Users which this query group belongs to
|
33
33
|
# @option opts [Array] queries Queries within the query group
|
34
34
|
# @option opts [Hash] sharedProjectIds Projects which this query group belongs to
|
35
|
-
# @return [
|
35
|
+
# @return [Hash] New query group
|
36
36
|
def create_query_group(project_id, opts = {})
|
37
37
|
post "projects/#{project_id}/querygroups", opts
|
38
38
|
end
|
@@ -48,7 +48,7 @@ module BWAPI
|
|
48
48
|
# @option opts [Array] users Users which this query group belongs to
|
49
49
|
# @option opts [Array] queries Queries within the query group
|
50
50
|
# @option opts [Hash] sharedProjectIds Projects which this query group belongs to
|
51
|
-
# @return [
|
51
|
+
# @return [Hash] New query group
|
52
52
|
def update_query_group(project_id, query_group_id, opts = {})
|
53
53
|
put "projects/#{project_id}/querygroups/#{query_group_id}", opts
|
54
54
|
end
|
@@ -57,7 +57,7 @@ module BWAPI
|
|
57
57
|
#
|
58
58
|
# @param project_id [Integer] Id of project
|
59
59
|
# @param query_group_id [Integer] Id of query group
|
60
|
-
# @return [
|
60
|
+
# @return [Hash] Deleted query group
|
61
61
|
def delete_query_group(project_id, query_group_id)
|
62
62
|
delete "projects/#{project_id}/querygroups/#{query_group_id}"
|
63
63
|
end
|
@@ -14,7 +14,7 @@ module BWAPI
|
|
14
14
|
# @option opts [Boolean] getPaused Includes the paused rules if true
|
15
15
|
# @option opts [Integer] page Page Number of results to retrieve
|
16
16
|
# @option opts [Integer] pageSize Results per page of results
|
17
|
-
# @return [
|
17
|
+
# @return [Hash] All rules in project
|
18
18
|
def rules(project_id, opts = {})
|
19
19
|
get "projects/#{project_id}/rules", opts
|
20
20
|
end
|
@@ -23,7 +23,7 @@ module BWAPI
|
|
23
23
|
#
|
24
24
|
# @param project_id [Integer] id The id of project
|
25
25
|
# @param rule_id [Integer] id The id of rule
|
26
|
-
# @return [
|
26
|
+
# @return [Hash] Specific rule
|
27
27
|
def get_rule(project_id, rule_id)
|
28
28
|
get "projects/#{project_id}/rules/#{rule_id}"
|
29
29
|
end
|
@@ -40,7 +40,7 @@ module BWAPI
|
|
40
40
|
# @option opts [Hash] rule Rule object
|
41
41
|
# @option opts [String] queryName The query name the rule is applied to
|
42
42
|
# @option opts [String] projectName The project name the rule is applied to
|
43
|
-
# @return [
|
43
|
+
# @return [Hash] New rule
|
44
44
|
def create_rule(project_id, opts = {})
|
45
45
|
post "projects/#{project_id}/rules", opts
|
46
46
|
end
|
@@ -57,7 +57,7 @@ module BWAPI
|
|
57
57
|
# @option opts [Hash] rule Rule object
|
58
58
|
# @option opts [String] queryName The query name the rule is applied to
|
59
59
|
# @option opts [String] projectName The project name the rule is applied to
|
60
|
-
# @return [
|
60
|
+
# @return [Hash] Updated rule
|
61
61
|
def update_rule(project_id, rule_id, opts = {})
|
62
62
|
put "projects/#{project_id}/rules/#{rule_id}", opts
|
63
63
|
end
|
@@ -66,7 +66,7 @@ module BWAPI
|
|
66
66
|
#
|
67
67
|
# @param project_id [Integer] Id The project id
|
68
68
|
# @param rule_id [Integer] Id The rule id
|
69
|
-
# @return [
|
69
|
+
# @return [Hash] Deleted rule
|
70
70
|
def delete_rule(project_id, rule_id)
|
71
71
|
delete "projects/#{project_id}/rules/#{rule_id}"
|
72
72
|
end
|
@@ -8,7 +8,7 @@ module BWAPI
|
|
8
8
|
#
|
9
9
|
# @param project_id [Integer] id The id of project
|
10
10
|
# @param rule_id [Integer] id The id of rule
|
11
|
-
# @return [
|
11
|
+
# @return [Hash] Specific rule backfill
|
12
12
|
def create_rule_backfill(project_id, rule_id)
|
13
13
|
post "projects/#{project_id}/rules/#{rule_id}/backfill"
|
14
14
|
end
|
@@ -10,7 +10,7 @@ module BWAPI
|
|
10
10
|
# @param rule_id [Integer] id The id of rule
|
11
11
|
# @param opts [Hash] options Hash of parameters
|
12
12
|
# @option opts [Integer] copyToProjectId the target project id
|
13
|
-
# @return [
|
13
|
+
# @return [Hash] New rule created in project
|
14
14
|
def create_rule_copy(project_id, rule_id, opts = {})
|
15
15
|
post "projects/#{project_id}/rules/#{rule_id}/copy", opts
|
16
16
|
end
|
@@ -5,7 +5,7 @@ module BWAPI
|
|
5
5
|
module Sharing
|
6
6
|
# Default shares of a project
|
7
7
|
#
|
8
|
-
# @return [
|
8
|
+
# @return [Hash] Default project shares information
|
9
9
|
def default_project_sharing
|
10
10
|
get 'projects/sharing'
|
11
11
|
end
|
@@ -15,7 +15,7 @@ module BWAPI
|
|
15
15
|
# @param project_id [Integer] Id of project
|
16
16
|
# @param opts [Hash] options hash of parameters
|
17
17
|
# @options opts [Boolean] sharedOnly Boolean flag to return only shared shares (default: false)
|
18
|
-
# @return [
|
18
|
+
# @return [Hash] Specific project shares
|
19
19
|
def project_sharing(project_id, opts = {})
|
20
20
|
get "projects/#{project_id}/sharing", opts
|
21
21
|
end
|
@@ -25,7 +25,7 @@ module BWAPI
|
|
25
25
|
# @param project_id [Integer] Id of project
|
26
26
|
# @param opts [Hash] options hash of parameters
|
27
27
|
# @options opts [Array] ProjectShareDTO Shares to be edited
|
28
|
-
# @return [
|
28
|
+
# @return [Hash] Updated project shares
|
29
29
|
def update_project_sharing(project_id, opts = {})
|
30
30
|
put "projects/#{project_id}/sharing", opts
|
31
31
|
end
|
@@ -34,7 +34,7 @@ module BWAPI
|
|
34
34
|
#
|
35
35
|
# @param project_id [Integer] Id of project
|
36
36
|
# @param user_id [Integer] Id of user
|
37
|
-
# @return [
|
37
|
+
# @return [Hash] Share of project for user
|
38
38
|
def project_sharing_user(project_id, user_id)
|
39
39
|
get "projects/#{project_id}/sharing/#{user_id}"
|
40
40
|
end
|
@@ -44,7 +44,7 @@ module BWAPI
|
|
44
44
|
# @param project_id [Integer] Id of project
|
45
45
|
# @param user_id [Integer] Id of user
|
46
46
|
# @options opts [Hash] User share to be edited
|
47
|
-
# @return [
|
47
|
+
# @return [Hash] Updated share of project for user
|
48
48
|
def update_project_sharing_user(project_id, user_id, opts = {})
|
49
49
|
put "projects/#{project_id}/sharing/#{user_id}", opts
|
50
50
|
end
|
@@ -15,7 +15,7 @@ module BWAPI
|
|
15
15
|
# @option opts [Integer] importance Importance of signal
|
16
16
|
# @option opts [String] type Type of signal
|
17
17
|
# @option opts [Hash] filter The filter(s) to apply
|
18
|
-
# @return [
|
18
|
+
# @return [Hash] All signals for user in project
|
19
19
|
def signals(project_id, opts = {})
|
20
20
|
get "projects/#{project_id}/signals", opts
|
21
21
|
end
|
@@ -10,7 +10,7 @@ module BWAPI
|
|
10
10
|
# @param projectId [Integer] Id of the existing project
|
11
11
|
# @option opts [Integer] page Page of results to retrieve
|
12
12
|
# @option opts [Integer] pageSize Results per page of results
|
13
|
-
# @return [
|
13
|
+
# @return [Hash] All signal groups for project
|
14
14
|
def signal_groups(project_id, opts = {})
|
15
15
|
get "/projects/#{project_id}/signals/groups", opts
|
16
16
|
end
|
@@ -18,7 +18,7 @@ module BWAPI
|
|
18
18
|
# Get a specific signal group
|
19
19
|
# @param projectId [Integer] Id of project
|
20
20
|
# @param groupId [Integer] Id of group
|
21
|
-
# @return [
|
21
|
+
# @return [Hash] specific signals group
|
22
22
|
def get_signal_group(project_id, group_id)
|
23
23
|
get "/projects/#{project_id}/signals/groups/#{group_id}"
|
24
24
|
end
|
@@ -33,7 +33,7 @@ module BWAPI
|
|
33
33
|
# @option opts [Date] lastModified Last modified date of the Signal Group
|
34
34
|
# @option opts [Integer] id ID of Signal Group
|
35
35
|
# @option opts [String] creator Creator of the Signal Group
|
36
|
-
# @return [
|
36
|
+
# @return [Hash] new signal group
|
37
37
|
def create_signal_group(project_id, opts = {})
|
38
38
|
post "/projects/#{project_id}/signals/groups", opts
|
39
39
|
end
|
@@ -49,7 +49,7 @@ module BWAPI
|
|
49
49
|
# @option opts [Date] lastModified Last modified date of the Signal Group
|
50
50
|
# @option opts [Integer] id ID of Signal Group
|
51
51
|
# @option opts [String] creator Creator of the Signal Group
|
52
|
-
# @return [
|
52
|
+
# @return [Hash] updated signal group
|
53
53
|
def update_signal_group(project_id, group_id, opts = {})
|
54
54
|
put "/projects/#{project_id}/signals/groups/#{group_id}", opts
|
55
55
|
end
|
@@ -57,7 +57,7 @@ module BWAPI
|
|
57
57
|
# Delete a signal group
|
58
58
|
# @param projectId [Integer] Id of project
|
59
59
|
# @param groupId [Integer] Id of group
|
60
|
-
# @return [
|
60
|
+
# @return [Hash] deleted signal group
|
61
61
|
def delete_signal_group(project_id, group_id)
|
62
62
|
delete "/projects/#{project_id}/signals/groups/#{group_id}"
|
63
63
|
end
|
@@ -11,7 +11,7 @@ module BWAPI
|
|
11
11
|
# @param opts [Hash] options hash of parameters
|
12
12
|
# @option opts [Integer] page Page of projects to retrieve
|
13
13
|
# @option opts [Integer] pageSize Results per page of results
|
14
|
-
# @return [
|
14
|
+
# @return [Hash] All stream dashboards for project
|
15
15
|
def stream_dashboards(project_id, opts = {})
|
16
16
|
get "projects/#{project_id}/streamDashboards", opts
|
17
17
|
end
|
@@ -22,7 +22,7 @@ module BWAPI
|
|
22
22
|
# @param opts [Hash] options hash of parameters
|
23
23
|
# @option opts [Integer] page Page of projects to retrieve
|
24
24
|
# @option opts [Integer] pageSize Results per page of results
|
25
|
-
# @return [
|
25
|
+
# @return [Hash] All stream dashboards summary for project
|
26
26
|
def get_stream_dashboards_summary(project_id)
|
27
27
|
get "projects/#{project_id}/streamDashboards/summary"
|
28
28
|
end
|
@@ -31,7 +31,7 @@ module BWAPI
|
|
31
31
|
#
|
32
32
|
# @param project_id [Integer] Id of project
|
33
33
|
# @param stream_dashboard_id [Integer] Id of stream dashboard
|
34
|
-
# @return [
|
34
|
+
# @return [Hash] Stream dashboard complete with streams
|
35
35
|
def get_stream_dashboard_complete(project_id, stream_dashboard_id)
|
36
36
|
get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/complete"
|
37
37
|
end
|
@@ -40,7 +40,7 @@ module BWAPI
|
|
40
40
|
#
|
41
41
|
# @param project_id [Integer] Id of project
|
42
42
|
# @param stream_dashboard_id [Integer] Id of stream dashboard
|
43
|
-
# @return [
|
43
|
+
# @return [Hash] Stream dashboard
|
44
44
|
def get_stream_dashboard(project_id, stream_dashboard_id)
|
45
45
|
get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}"
|
46
46
|
end
|
@@ -53,7 +53,7 @@ module BWAPI
|
|
53
53
|
# @option opts [String] name Name of the stream
|
54
54
|
# @option opts [String] created The stream creation date
|
55
55
|
# @option opts [String] filter the stream filter
|
56
|
-
# @return [
|
56
|
+
# @return [Hash] New stream dashboard
|
57
57
|
def create_stream_dashboard(project_id, opts = {})
|
58
58
|
post "projects/#{project_id}/streamDashboards", opts
|
59
59
|
end
|
@@ -67,7 +67,7 @@ module BWAPI
|
|
67
67
|
# @option opts [String] name Name of the stream
|
68
68
|
# @option opts [String] created The stream creation date
|
69
69
|
# @option opts [String] filter the stream filter
|
70
|
-
# @return [
|
70
|
+
# @return [Hash] Updated stream dashboard
|
71
71
|
def update_stream_dashboard(project_id, stream_dashboard_id, opts = {})
|
72
72
|
put "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}", opts
|
73
73
|
end
|
@@ -10,7 +10,7 @@ module BWAPI
|
|
10
10
|
# @param opts [Hash] options hash of parameters
|
11
11
|
# @option opts [Integer] page Page of results to retrieve
|
12
12
|
# @option opts [Integer] pageSize Results per page of results
|
13
|
-
# @return [
|
13
|
+
# @return [Hash] All stream dashboards for project
|
14
14
|
def get_streams(project_id, stream_dashboard_id)
|
15
15
|
get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams"
|
16
16
|
end
|
@@ -20,7 +20,7 @@ module BWAPI
|
|
20
20
|
# @param project_id [Integer] Id of project
|
21
21
|
# @param stream_dashboard_id [Integer] Id of stream dashboard
|
22
22
|
# @param stream_id [Integer] Id of the stream
|
23
|
-
# @return [
|
23
|
+
# @return [Hash] Specific stream
|
24
24
|
def get_stream(project_id, stream_dashboard_id, stream_id)
|
25
25
|
get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}"
|
26
26
|
end
|
@@ -36,7 +36,7 @@ module BWAPI
|
|
36
36
|
# @option opts [String] filter Filter of the stream
|
37
37
|
# @option opts [String] settings Settings of the stream
|
38
38
|
# @option opts [String] lastModified Last modification date of stream
|
39
|
-
# @return [
|
39
|
+
# @return [Hash] Specific stream
|
40
40
|
def create_stream(project_id, stream_dashboard_id, opts = {})
|
41
41
|
post "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams", opts
|
42
42
|
end
|
@@ -53,7 +53,7 @@ module BWAPI
|
|
53
53
|
# @option opts [String] filter Filter of the stream
|
54
54
|
# @option opts [String] settings Settings of the stream
|
55
55
|
# @option opts [String] lastModified Last modification date of stream
|
56
|
-
# @return [
|
56
|
+
# @return [Hash] Updated stream
|
57
57
|
def update_stream(project_id, stream_dashboard_id, stream_id, opts = {})
|
58
58
|
put "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}", opts
|
59
59
|
end
|
@@ -63,7 +63,7 @@ module BWAPI
|
|
63
63
|
# @param project_id [Integer] Id of project
|
64
64
|
# @param stream_dashboard_id [Integer] Id of stream dashboard
|
65
65
|
# @param stream_id [Integer] Id of the stream
|
66
|
-
# @return [
|
66
|
+
# @return [Hash] Deleted stream
|
67
67
|
def delete_stream(project_id, stream_dashboard_id, stream_id)
|
68
68
|
delete "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}"
|
69
69
|
end
|
@@ -9,7 +9,7 @@ module BWAPI
|
|
9
9
|
# @option opts [Integer] page Page of projects to retrieve
|
10
10
|
# @option opts [Integer] pageSize Results per page of results
|
11
11
|
# @option opts [String] :filter Filter to apply to the query
|
12
|
-
# @return [
|
12
|
+
# @return [Hash] Project summary information
|
13
13
|
def projects_summary(opts = {})
|
14
14
|
get 'projects/summary', opts
|
15
15
|
end
|
@@ -8,7 +8,7 @@ module BWAPI
|
|
8
8
|
# @param project_id [Integer] Id of project
|
9
9
|
# @option opts [Integer] page Page of projects to retrieve
|
10
10
|
# @option opts [Integer] pageSize Results per page of results
|
11
|
-
# @return [
|
11
|
+
# @return [Hash] All tags in project
|
12
12
|
def tags(project_id, opts = {})
|
13
13
|
get "projects/#{project_id}/tags", opts
|
14
14
|
end
|
@@ -17,7 +17,7 @@ module BWAPI
|
|
17
17
|
#
|
18
18
|
# @param project_id [Integer] Id of project
|
19
19
|
# @param tag_id [Integer] Id of tag
|
20
|
-
# @return [
|
20
|
+
# @return [Hash] Specific tag
|
21
21
|
def get_tag(project_id, tag_id)
|
22
22
|
get "projects/#{project_id}/tags/#{tag_id}"
|
23
23
|
end
|
@@ -28,7 +28,7 @@ module BWAPI
|
|
28
28
|
# @param opts [Hash] options hash of parameters
|
29
29
|
# @option opts [Integer] id Id of the tag
|
30
30
|
# @option opts [String] name Name of the tag
|
31
|
-
# @return [
|
31
|
+
# @return [Hash] New tag
|
32
32
|
def create_tag(project_id, opts = {})
|
33
33
|
post "projects/#{project_id}/tags", opts
|
34
34
|
end
|
@@ -40,7 +40,7 @@ module BWAPI
|
|
40
40
|
# @param opts [Hash] options hash of parameters
|
41
41
|
# @option opts [Integer] id Id of the tag
|
42
42
|
# @option opts [String] name Name of the tag
|
43
|
-
# @return [
|
43
|
+
# @return [Hash] Updated tag
|
44
44
|
def update_tag(project_id, tag_id, opts = {})
|
45
45
|
put "projects/#{project_id}/tags/#{tag_id}", opts
|
46
46
|
end
|
@@ -49,7 +49,7 @@ module BWAPI
|
|
49
49
|
#
|
50
50
|
# @param project_id [Integer] Id of project
|
51
51
|
# @param tag_id [Integer] Id of tag
|
52
|
-
# @return [
|
52
|
+
# @return [Hash] Deleted tag
|
53
53
|
def delete_tag(project_id, tag_id)
|
54
54
|
delete "projects/#{project_id}/tags/#{tag_id}"
|
55
55
|
end
|