bwapi 10.0.0 → 11.0.0.pre.550

data/lib/bwapi/client/brandwatch/clients/users.rb

@@ -6,8 +6,6 @@ module BWAPI
         module Users
           # Create a new client user
           #
-          # @note must be a super admin user
-          #
           # @param client_id [Integer] Id of the client
           # @param opts [Hash] options Hash of parameters
           # @option opts [String] address The users address

data/lib/bwapi/client/brandwatch/command_center.rb

@@ -0,0 +1,14 @@
+require 'bwapi/client/brandwatch/command_center/scene_types'
+require 'bwapi/client/brandwatch/command_center/themes'
+
+module BWAPI
+  class Client
+    module Brandwatch
+      # CommandCenter module for brandwatch/commandcenter endpoints
+      module CommandCenter
+        include BWAPI::Client::Brandwatch::CommandCenter::SceneTypes
+        include BWAPI::Client::Brandwatch::CommandCenter::Themes
+      end
+    end
+  end
+end

data/lib/bwapi/client/brandwatch/command_center/scene_types.rb

@@ -0,0 +1,31 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      module CommandCenter
+        # SceneTypes module for brandwatch/commandcenter/scenetypes endpoints
+        module SceneTypes
+          # Fetch all supported parent scene types
+          #
+          # TODO: Add parameters documentation
+          def brandwatch_all_scene_types
+            get 'brandwatch/commandcenter/scenetypes'
+          end
+
+          # Fetch a scene type
+          #
+          # TODO: Add parameters documentation
+          def brandwatch_scene_type(scene_type_id)
+            get "brandwatch/commandcenter/scenetypes/#{scene_type_id}"
+          end
+
+          # Fetch all sub scene types for a scene type
+          #
+          # TODO: Add parameters documentation
+          def brandwatch_scene_type_with_sub_scenes(scene_type_id)
+            get "brandwatch/commandcenter/scenetypes/#{scene_type_id}/subscenes"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/brandwatch/command_center/themes.rb

@@ -0,0 +1,17 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      module CommandCenter
+        # Themes module for brandwatch/commandcenter/themes endpoints
+        module Themes
+          # Get supported Vizia themes
+          #
+          # @return [Hash] All themes
+          def brandwatch_all_themes
+            get 'brandwatch/commandcenter/themes'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/brandwatch/log_level.rb

@@ -0,0 +1,17 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      # Loglevel module for brandwatch/log-level endpoint
+      module LogLevel
+        # Change the API LogLevel
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [String] logLevel for API2
+        # @return [Array] Returns the updated log level
+        def brandwatch_log_level(opts = {})
+          post 'brandwatch/log-level', opts
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/brandwatch/price_structures.rb

@@ -0,0 +1,45 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      # PriceStructures module for brandwatch/pricestructures endpoint
+      module PriceStructures
+        # Show available price structures
+        #
+        # @return [Array] List of all price structures
+        def get_price_structures
+          get 'brandwatch/pricestructures'
+        end
+
+        # Create a new price structure
+        #
+        # @param opts [Hash] options Hash of parameters
+        # @option opts [Integer] autoDeleteDays Auto delete days of the price structure
+        # @option opts [Boolean] autoUpgrade If the price structure can be auto upgraded
+        # @option opts [Integer] availableBackfillMonths Available backfill months of the price structure
+        # @option opts [Integer] backfillMentionLimit Backfill mention limit of the price structure
+        # @option opts [String] backfillMentionLimitPeriod Backfill mention limit period of the price structure
+        # @option opts [String] currencyCode Currency code of the price structure
+        # @option opts [String] description Description of the price structure
+        # @option opts [Boolean] forWebSignUp If the price structure is for web sign up
+        # @option opts [Integer] id Id of the price structure
+        # @option opts [String] mentionLimitPeriod Mention limit period of the price structure
+        # @option opts [String] name Name of the price structure
+        # @option opts [String] notes Notes for the price structure
+        # @option opts [Array] priceStructureLines Price structure lines belonging to the price structure
+        # @option opts [Boolean] resellerAllowed If the price structure is reseller allowed
+        # @return [Hash] Newly created price structure
+        def create_price_structure(opts)
+          post 'brandwatch/pricestructures', opts
+        end
+
+        # Delete a price structure
+        #
+        # @param price_structure_id [Integer] Id of the price structure
+        # @return [Hash] Deleted price structure
+        def delete_price_structure(price_structure_id)
+          delete "brandwatch/pricestructures/#{price_structure_id}"
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/brandwatch/usage_report.rb

@@ -0,0 +1,19 @@
+module BWAPI
+  class Client
+    module Brandwatch
+      # usageReport module for brandwatch/usageReport endpoint
+      module UsageReport
+        # Get the Clients Mention Usage report
+        #
+        # @param clientId [Integer] Id of client
+        # @param startDate [DateTime] Report startDate
+        # @param endDate [DateTime] Report endDate
+        # @param opts [Hash] options hash of parameters
+        # @return [Hash] Returns usage report for active client
+        def brandwatch_usage_report(clientId, startDate, endDate, opts = {})
+          get "brandwatch/usageReport/client/#{clientId}/start/#{startDate}/end/#{endDate}", opts
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center.rb

@@ -1,6 +1,12 @@
+require 'bwapi/client/command_center/category_colours'
 require 'bwapi/client/command_center/client'
+require 'bwapi/client/command_center/colour_palette'
+require 'bwapi/client/command_center/display_access'
 require 'bwapi/client/command_center/displays'
+require 'bwapi/client/command_center/projects'
+require 'bwapi/client/command_center/query_colours'
 require 'bwapi/client/command_center/scene_types'
+require 'bwapi/client/command_center/tag_colours'
 require 'bwapi/client/command_center/themes'
 require 'bwapi/client/command_center/users'
 
@@ -8,9 +14,15 @@ module BWAPI
   class Client
     # CommandCenter module for commandcenter endpoints
     module CommandCenter
+      include BWAPI::Client::CommandCenter::CategoryColours
       include BWAPI::Client::CommandCenter::Client
+      include BWAPI::Client::CommandCenter::ColourPalette
+      include BWAPI::Client::CommandCenter::DisplayAccess
       include BWAPI::Client::CommandCenter::Displays
+      include BWAPI::Client::CommandCenter::Projects
+      include BWAPI::Client::CommandCenter::QueryColours
       include BWAPI::Client::CommandCenter::SceneTypes
+      include BWAPI::Client::CommandCenter::TagColours
       include BWAPI::Client::CommandCenter::Themes
       include BWAPI::Client::CommandCenter::Users
     end

data/lib/bwapi/client/command_center/category_colours.rb

@@ -0,0 +1,15 @@
+module BWAPI
+  class Client
+    module CommandCenter
+      # CategoryColours module for commandcenter/categoryColours endpoints
+      module CategoryColours
+        # Get colours defined for categories in current client
+        #
+        # TODO: Add parameters documentation
+        def all_category_colours
+          get 'commandcenter/categoryColours'
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/colour_palette.rb

@@ -0,0 +1,22 @@
+module BWAPI
+  class Client
+    module CommandCenter
+      # ColourPalette module for commandcenter/colourPalette endpoints
+      module ColourPalette
+        # Get the colour palette for the current client
+        #
+        # TODO: Add parameters documentation
+        def colour_palette
+          get '/commandcenter/colourPalette'
+        end
+
+        # Update the colour palette for the current client
+        #
+        # TODO: Add parameters documentation
+        def update_colour_palette(opts = {})
+          put '/commandcenter/colourPalette', opts
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/display_access.rb

@@ -0,0 +1,12 @@
+require 'bwapi/client/command_center/display_access/users'
+
+module BWAPI
+  class Client
+    module CommandCenter
+      # DisplayAccess module for commandcenter/displayaccess endpoints
+      module DisplayAccess
+        include BWAPI::Client::CommandCenter::DisplayAccess::Users
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/display_access/users.rb

@@ -0,0 +1,14 @@
+require 'bwapi/client/command_center/display_access/users/access'
+
+module BWAPI
+  class Client
+    module CommandCenter
+      module DisplayAccess
+        # Users module for commandcenter/displayaccess/users endpoints
+        module Users
+          include BWAPI::Client::CommandCenter::DisplayAccess::Users::Access
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/display_access/users/access.rb

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module CommandCenter
+      module DisplayAccess
+        module Users
+          # Access module for commandcenter/displayaccess/users/{user_id}/access endpoints
+          module Access
+            # Alter specific user's access to multiple specified displays
+            #
+            # @param [Integer] user_id the user id
+            # @param [Integer] access_level the access level
+            # TODO: Add parameters documentation
+            def update_displays_user_access_level(user_id, access_level, opts = {})
+              put "commandcenter/displayaccess/users/#{user_id}/access/#{access_level}", opts
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/displays/scenes.rb

@@ -35,7 +35,7 @@ module BWAPI
           # @param [Integer] display_id The display id
           # @param opts [Hash] options hash of parameters
           # @option opts [Integer] id The id of scene
-          # @option opts String] name The name of the scene
+          # @option opts [String] name The name of the scene
           # @option opts [Integer] projectId The project id
           # @option opts [Integer] displayId The display id
           # @option opts [Hash] options Scene options

data/lib/bwapi/client/command_center/projects.rb

@@ -0,0 +1,16 @@
+require 'bwapi/client/command_center/projects/category_colours'
+require 'bwapi/client/command_center/projects/data'
+require 'bwapi/client/command_center/projects/tag_colours'
+
+module BWAPI
+  class Client
+    module CommandCenter
+      # Projects module for commandcenter/projects endpoints
+      module Projects
+        include BWAPI::Client::CommandCenter::Projects::CategoryColours
+        include BWAPI::Client::CommandCenter::Projects::Data
+        include BWAPI::Client::CommandCenter::Projects::TagColours
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/projects/category_colours.rb

@@ -0,0 +1,45 @@
+module BWAPI
+  class Client
+    module CommandCenter
+      module Projects
+        # CategoryColours module for commandcenter/projects/{project_id}/categoryColours endpoints
+        module CategoryColours
+          # Get colours defined for categories in given project
+          #
+          # TODO: Add parameters documentation
+          def category_colours(project_id)
+            get "/commandcenter/projects/#{project_id}/categoryColours"
+          end
+
+          # Get colour defined for given category
+          #
+          # TODO: Add parameters documentation
+          def category_colour(project_id, category_id)
+            get "/commandcenter/projects/#{project_id}/categoryColours/#{category_id}"
+          end
+
+          # Define the colour for a category
+          #
+          # TODO: Add parameters documentation
+          def create_category_colour(project_id, opts = {})
+            post "/commandcenter/projects/#{project_id}/categoryColours", opts
+          end
+
+          # Update the colour for a category
+          #
+          # TODO: Add parameters documentation
+          def update_category_colour(project_id, category_id, opts = {})
+            put "/commandcenter/projects/#{project_id}/categoryColours/#{category_id}", opts
+          end
+
+          # Remove the colour for a category
+          #
+          # TODO: Add parameters documentation
+          def delete_category_colour(project_id, category_id)
+            delete "/commandcenter/projects/#{project_id}/categoryColours/#{category_id}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/projects/data.rb

@@ -0,0 +1,21 @@
+module BWAPI
+  class Client
+    module CommandCenter
+      module Projects
+        # Data module for commandcenter/projects/{project_id}/data endpoints
+        module Data
+          # Retrieve aggregate data and sample mentions broken down by specified dimensions
+          #
+          # @param project_id [Integer] Id of project
+          # @param aggregate [String] Aggregate value
+          # @param dimension_one [String] Dimension 1 value
+          # @param dimension_two [String] Dimension 2 value
+          # TODO: Add parameters documentation
+          def command_center_data(project_id, aggregate, dimension_one, dimension_two, opts = {})
+            get "commandcenter/projects/#{project_id}/data/#{aggregate}/#{dimension_one}/#{dimension_two}", opts
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/projects/tag_colours.rb

@@ -0,0 +1,45 @@
+module BWAPI
+  class Client
+    module CommandCenter
+      module Projects
+        # TagColours module for commandcenter/projects/{project_id}/tagColours endpoints
+        module TagColours
+          # Get colours defined for tags in given project
+          #
+          # TODO: Add parameters documentation
+          def tag_colours(project_id)
+            get "/commandcenter/projects/#{project_id}/tagColours"
+          end
+
+          # Get colour defined for given tag
+          #
+          # TODO: Add parameters documentation
+          def tag_colour(project_id, tag_name)
+            get "/commandcenter/projects/#{project_id}/tagColours/#{tag_name}"
+          end
+
+          # Define the colour for a tag
+          #
+          # TODO: Add parameters documentation
+          def create_tag_colour(project_id, opts = {})
+            post "/commandcenter/projects/#{project_id}/tagColours", opts
+          end
+
+          # Update the colour for a tag
+          #
+          # TODO: Add parameters documentation
+          def update_tag_colour(project_id, tag_name, opts = {})
+            put "/commandcenter/projects/#{project_id}/tagColours/#{tag_name}", opts
+          end
+
+          # Remove the colour for a tag
+          #
+          # TODO: Add parameters documentation
+          def delete_tag_colour(project_id, tag_name)
+            delete "/commandcenter/projects/#{project_id}/tagColours/#{tag_name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bwapi/client/command_center/query_colours.rb

@@ -0,0 +1,36 @@
+module BWAPI
+  class Client
+    module CommandCenter
+      # QueryColours module for commandcenter/queryColours endpoints
+      module QueryColours
+        # Get colours defined for queries in current client
+        #
+        # TODO: Add parameters documentation
+        def query_colours
+          get 'commandcenter/queryColours'
+        end
+
+        # Define the colour for a query
+        #
+        # TODO: Add parameters documentation
+        def create_query_colour(opts = {})
+          post 'commandcenter/queryColours', opts
+        end
+
+        # Get colours defined for queries in current client
+        #
+        # TODO: Add parameters documentation
+        def update_query_colour(query_id)
+          put "/commandcenter/queryColours/#{query_id}"
+        end
+
+        # Get colours defined for queries in current client
+        #
+        # TODO: Add parameters documentation
+        def delete_query_colour(query_id)
+          delete "/commandcenter/queryColours/#{query_id}"
+        end
+      end
+    end
+  end
+end