bwapi 9.0.0.pre.390 → 9.0.0.pre.401

data/lib/bwapi/client/projects.rb

@@ -26,7 +26,7 @@ module BWAPI
       # @param opts [Hash] options hash of parameters
       # @option opts [Integer] page Page of results to retrieve
       # @option opts [Integer] pageSize Results per page of results
-      # @return [Hashie::Mash] All projects
+      # @return [Hash] All projects
       def projects(opts = {})
         get 'projects', opts
       end
@@ -34,7 +34,7 @@ module BWAPI
       # Get a specific project
       #
       # @param project_id [Integer] Id of the existing project
-      # @return [Hashie::Mash] Specific project
+      # @return [Hash] Specific project
       def get_project(project_id)
         get "projects/#{project_id}"
       end
@@ -50,7 +50,7 @@ module BWAPI
       # @option opts [Array] defaultLangCodes Default languages of the project
       # @option opts [Date] creationDate Date the project was created on
       # @option opts [Integer] creationUserId User ID of the user who created the project
-      # @return [Hashie::Mash] New project
+      # @return [Hash] New project
       def create_project(opts = {})
         post 'projects', opts
       end
@@ -67,7 +67,7 @@ module BWAPI
       # @option opts [Array] defaultLangCodes Default languages of the project
       # @option opts [Date] creationDate Date the project was created on
       # @option opts [Integer] creationUserId User ID of the user who created the project
-      # @return [Hashie::Mash] Updated project
+      # @return [Hash] Updated project
       def update_project(project_id, opts = {})
         put "projects/#{project_id}", opts
       end
@@ -75,7 +75,7 @@ module BWAPI
       # Delete an existing project
       #
       # @param project_id [Integer] id Id of the existing project
-      # @return [Hashie::Mash] Deleted project
+      # @return [Hash] Deleted project
       def delete_project(project_id)
         delete "projects/#{project_id}"
       end

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

@@ -13,7 +13,7 @@ module BWAPI
         # @option opts [Integer] page Page of projects to retrieve
         # @option opts [Integer] pageSize Results per page of results
         # @option opts [String] sinceDate the start date to get bulk actions from
-        # @return [Hashie::Mash] All bulk actions in project
+        # @return [Hash] All bulk actions in project
         def bulk_actions(project_id, opts = {})
           get "projects/#{project_id}/bulkactions", opts
         end

data/lib/bwapi/client/projects/bulkactions/author.rb

@@ -15,7 +15,7 @@ module BWAPI
           # @option opts [Integer] id of the bulk action
           # @option opts [Array] interests list<String> Interests to assign
           # @option opts [Array] professions list<AuthorProfessionDTO> Professions to assign
-          # @return [Hashie::Mash] New bulk action for mentions
+          # @return [Hash] New bulk action for mentions
           def bulk_edit_author(project_id, opts = {})
             post "projects/#{project_id}/bulkactions/author", opts
           end

data/lib/bwapi/client/projects/bulkactions/mentions.rb

@@ -11,7 +11,7 @@ module BWAPI
           # @option opts [Hash] action <mention patch dto> to apply to these mentions
           # @option opts [Hash] filter <filter dto> to specify what kind of mentions this bulk action should apply to
           # @option opts [Integer] sampleAmount Amount to be sample by this bulk action
-          # @return [Hashie::Mash] New bulk action for mentions
+          # @return [Hash] New bulk action for mentions
           def bulk_edit_mentions(project_id, opts = {})
             post "projects/#{project_id}/bulkactions/mentions", opts
           end

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

@@ -11,7 +11,7 @@ module BWAPI
         # @param opts [Hash] options hash of parameters
         # @option opts [Integer] page Page of projects to retrieve
         # @option opts [Integer] pageSize Results per page of results
-        # @return [Hashie::Mash] All categories in project
+        # @return [Hash] All categories in project
         def categories(project_id, opts = {})
           get "projects/#{project_id}/categories", opts
         end
@@ -24,7 +24,7 @@ module BWAPI
         # @option opts [String] name Name of the category
         # @option opts [Array] children The children of the category
         # @option opts [Boolean] multiple Whether multiple sub categories can be selected
-        # @return [Hashie::Mash] New category
+        # @return [Hash] New category
         def create_category(project_id, opts = {})
           post "projects/#{project_id}/categories", opts
         end
@@ -38,7 +38,7 @@ module BWAPI
         # @option opts [String] name Name of the category
         # @option opts [Array] children The children of the category
         # @option opts [Boolean] multiple Whether multiple sub categories can be selected
-        # @return [Hashie::Mash] Updated category
+        # @return [Hash] Updated category
         def update_category(project_id, category_id, opts = {})
           put "projects/#{project_id}/categories/#{category_id}", opts
         end
@@ -47,7 +47,7 @@ module BWAPI
         #
         # @param project_id [Integer] Id of project
         # @param category_id [Integer] Id of query group
-        # @return [Hashie::Mash] Deleted category
+        # @return [Hash] Deleted category
         def delete_category(project_id, category_id)
           delete "projects/#{project_id}/categories/#{category_id}"
         end

data/lib/bwapi/client/projects/categories/copy.rb

@@ -10,7 +10,7 @@ module BWAPI
           # @param category_id [Integer] Id of query group
           # @param opts [Hash] options hash of parameters
           # @option opts [Hash] destinationProjectId target project id for copy
-          # @return [Hashie::Mash] Copied category
+          # @return [Hash] Copied category
           def copy_category(project_id, category_id, opts = {})
             post "projects/#{project_id}/categories/#{category_id}/copy", opts
           end

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

@@ -14,7 +14,7 @@ module BWAPI
         # @param dimension_two [String] Dimension 2 value
         # @param opts [Hash] options hash of parameters
         # @option opts [Hash] filter The filters to apply
-        # @return [Hashie::Mash] All Chart data mentions
+        # @return [Hash] All Chart data mentions
         def data(project_id, aggregate, dimension_one, dimension_two, opts = {})
           get "projects/#{project_id}/data/#{aggregate}/#{dimension_one}/#{dimension_two}", opts
         end
@@ -24,7 +24,7 @@ module BWAPI
         # @param project_id [Integer] Id of project
         # @param opts [Hash] options hash of parameters
         # @option opts [Hash] filter The filters to apply
-        # @return [Hashie::Mash] Headline figures for spedified channels
+        # @return [Hash] Headline figures for spedified channels
         def data_headlines(project_id, opts = {})
           get "projects/#{project_id}/data/headlines", opts
         end

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

@@ -16,7 +16,7 @@ module BWAPI
           # @option opts [String] orderBy Parameter to sort by
           # @option opts [String] orderDirection Direction of sort
           # @option opts [Integer] orderByCategory Category to sort by when orderBy category
-          # @return [Hashie::Mash] All Mentions
+          # @return [Hash] All Mentions
           def data_mentions(project_id, opts = {})
             get "projects/#{project_id}/data/mentions", opts
           end
@@ -26,7 +26,7 @@ module BWAPI
           # @param project_id [Integer] Id of project
           # @param opts [Hash] options hash of parameters
           # @option opts [Hash] List The patches to be applied
-          # @return [Hashie::Mash] Updated mentions
+          # @return [Hash] Updated mentions
           def update_data_mentions(project_id, opts = {})
             patch "projects/#{project_id}/data/mentions", opts
           end
@@ -41,7 +41,7 @@ module BWAPI
           # @option opts [String] orderBy Parameter to sort by
           # @option opts [String] orderDirection Direction of sort
           # @option opts [Integer] orderByCategory Category to sort by when orderBy category
-          # @return [Hashie::Mash] All Mentions
+          # @return [Hash] All Mentions
           def data_mentions_fulltext(project_id, opts = {})
             get "projects/#{project_id}/data/mentions/fulltext", opts
           end
@@ -56,7 +56,7 @@ module BWAPI
           # @option opts [String] orderBy Parameter to sort by
           # @option opts [String] orderDirection Direction of sort
           # @option opts [Integer] orderByCategory Category to sort by when orderBy category
-          # @return [Hashie::Mash] All Mentions
+          # @return [Hash] All Mentions
           def data_mentions_tweets(project_id, opts = {})
             get "projects/#{project_id}/data/mentions/tweets", opts
           end

data/lib/bwapi/client/projects/data/mentions/notes.rb

@@ -13,7 +13,7 @@ module BWAPI
             # @option opts [Integer] project_id the id of the project the mention is in
             # @option opts [Integer] resource_id the id of the mention
             # @option opts [String] text the text of the note
-            # @return [Hashie::Mash] the new note
+            # @return [Hash] the new note
             def create_mention_note(project_id, resource_id, opts = {})
               post "projects/#{project_id}/data/mentions/#{resource_id}/notes", opts
             end
@@ -23,7 +23,7 @@ module BWAPI
             # @param project_id [Integer] Id of project
             # @param resource_id [Integer] Id of mention
             # @param note_id [Integer] Id of the note
-            # @return [Hashie::Mash] the selected note
+            # @return [Hash] the selected note
             def mention_note(project_id, resource_id, note_id)
               get "projects/#{project_id}/data/mentions/#{resource_id}/notes/#{note_id}"
             end
@@ -37,7 +37,7 @@ module BWAPI
             # @option opts [Integer] project_id the id of the project the mention is in
             # @option opts [Integer] resource_id the id of the mention
             # @option opts [String] text the text of the note
-            # @return [Hashie::Mash] the edited note
+            # @return [Hash] the edited note
             def update_mention_note(project_id, resource_id, note_id, opts = {})
               put "projects/#{project_id}/data/mentions/#{resource_id}/notes/#{note_id}", opts
             end
@@ -49,7 +49,7 @@ module BWAPI
             # @param note_id [Integer] Id of the note
             # @param opts [Hash] options hash of parameters
             # @option opts [String] prependNote the text of the note
-            # @return [Hashie::Mash] the patched note
+            # @return [Hash] the patched note
             def patch_mention_note(project_id, resource_id, note_id, opts = {})
               patch "projects/#{project_id}/data/mentions/#{resource_id}/notes/#{note_id}", opts
             end

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

@@ -10,7 +10,7 @@ module BWAPI
           # @param opts [Hash] options hash of parameters
           # @option opts [Hash] filter The filters to apply
           # @option opts [Array] dateRanges Date range ids
-          # @return [Hashie::Mash] All Chart data mentions
+          # @return [Hash] All Chart data mentions
           def data_volume_date_ranges_days(project_id, opts = {})
             get "projects/#{project_id}/data/volume/dataRanges/days", opts
           end

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

@@ -8,7 +8,7 @@ module BWAPI
         # @param project_id [Integer] Id of project
         # @option opts [Integer] page Page of projects to retrieve
         # @option opts [Integer] pageSize Results per page of results
-        # @return [Hashie::Mash] All data downloads in project
+        # @return [Hash] All data downloads in project
         def data_downloads(project_id, opts = {})
           get "projects/#{project_id}/datadownload", opts
         end
@@ -17,7 +17,7 @@ module BWAPI
         #
         # @param project_id [Integer] Id of project
         # @param data_download_id [Integer] Id of data download
-        # @return [Hashie::Mash] Specific data download
+        # @return [Hash] Specific data download
         def get_data_download(project_id, data_download_id)
           get "projects/#{project_id}/datadownload/#{data_download_id}"
         end
@@ -37,7 +37,7 @@ module BWAPI
         # @option opts [String] downloadLinkXLS The link to download the XLS format
         # @option opts [String] downloadLinkCSV The link to download the CSV format
         # @option opts [Array] additionalColumns The additional columns for the data download
-        # @return [Hashie::Mash] New data download
+        # @return [Hash] New data download
         def create_data_download(project_id, opts = {})
           post "projects/#{project_id}/datadownload", opts
         end

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

@@ -10,7 +10,7 @@ module BWAPI
         # @param opts [Hash] options Hash of parameters
         # @option opts [Integer] limit The limit to return
         # @option opts [Hash] filter The filters to apply
-        # @return [Hashie::Mash] All data downloads in project
+        # @return [Hash] All data downloads in project
         def demographics(project_id, metric, opts = {})
           get "projects/#{project_id}/demographics/#{metric}", opts
         end

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

@@ -6,7 +6,7 @@ module BWAPI
         # Get all facebook queries in a project
         #
         # @param project_id [Integer] Id of project
-        # @return [Hashie::Mash] All facebook queries in project
+        # @return [Hash] All facebook queries in project
         def facebook_queries(project_id)
           get "projects/#{project_id}/facebookqueries"
         end
@@ -15,7 +15,7 @@ module BWAPI
         #
         # @param project_id [Integer] Id of project
         # @param query_id [Integer] Id of facebook query
-        # @return [Hashie::Mash] Specific facebook query
+        # @return [Hash] Specific facebook query
         def get_facebook_query(project_id, query_id)
           get "projects/#{project_id}/facebookqueries/#{query_id}"
         end
@@ -43,7 +43,7 @@ module BWAPI
         # @option opts [String] type Query type
         # @option opts [String] facebookConsumerKey Facebook consumer key
         # @option opts [String] facebookAccessToken Facebook access token
-        # @return [Hashie::Mash] New facebook query
+        # @return [Hash] New facebook query
         def create_facebook_query(project_id, opts = {})
           post "projects/#{project_id}/facebookqueries", opts
         end
@@ -55,7 +55,7 @@ module BWAPI
         # @option opts [String] accessToken Facebook access token
         # @option opts [String] consumerKey Facebook consumer key
         # @option opts [Array] queryIds Array of query ids
-        # @return [Hashie::Mash] Authorised facebook queries
+        # @return [Hash] Authorised facebook queries
         def authorise_facebook_queries(project_id, opts = {})
           post "projects/#{project_id}/facebookqueries/authorise", opts
         end
@@ -84,7 +84,7 @@ module BWAPI
         # @option opts [String] type Query type
         # @option opts [String] facebookConsumerKey Facebook consumer key
         # @option opts [String] facebookAccessToken Facebook access token
-        # @return [Hashie::Mash] Updated facebook query
+        # @return [Hash] Updated facebook query
         def update_facebook_query(project_id, query_id, opts = {})
           put "projects/#{project_id}/facebookqueries/#{query_id}", opts
         end

data/lib/bwapi/client/projects/group/author_group.rb

@@ -7,7 +7,7 @@ module BWAPI
           # Get summary of all author groups in project
           #
           # @param project_id [Integer] Id of project
-          # @return [Hashie::Mash] Summary of all author groups in project
+          # @return [Hash] Summary of all author groups in project
           def author_groups_summary(project_id, opts = {})
             get "projects/#{project_id}/group/author/summary", opts
           end
@@ -16,7 +16,7 @@ module BWAPI
           #
           # @param project_id [Integer] Id of project
           # @param author_group_id [Integer] Id of author group
-          # @return [Hashie::Mash] Specific author group
+          # @return [Hash] Specific author group
           def get_author_group(project_id, author_group_id)
             get "projects/#{project_id}/group/author/#{author_group_id}"
           end
@@ -30,7 +30,7 @@ module BWAPI
           # @option opts [Array] sharedProjectIds The ids of the shared projects
           # @option opts [String] shared The type of sharing for the group
           # @option opts [Array] authors The authors in the group
-          # @return [Hashie::Mash] New author group
+          # @return [Hash] New author group
           def create_author_group(project_id, opts = {})
             post "projects/#{project_id}/group/author", opts
           end
@@ -46,7 +46,7 @@ module BWAPI
           # @option opts [Array] sharedProjectIds The ids of the shared projects
           # @option opts [String] shared The type of sharing for the group
           # @option opts [Array] authors The authors in the group
-          # @return [Hashie::Mash] Updated author group
+          # @return [Hash] Updated author group
           def update_author_group(project_id, author_group_id, opts = {})
             put "projects/#{project_id}/group/author/#{author_group_id}", opts
           end
@@ -55,7 +55,7 @@ module BWAPI
           #
           # @param project_id [Integer] Id of project
           # @param author_group_id [Integer] Id of author group
-          # @return [Hashie::Mash] Deleted author group
+          # @return [Hash] Deleted author group
           def delete_author_group(project_id, author_group_id)
             delete "projects/#{project_id}/group/author/#{author_group_id}"
           end

data/lib/bwapi/client/projects/group/location_group.rb

@@ -7,7 +7,7 @@ module BWAPI
           # Get summary of all location groups in project
           #
           # @param project_id [Integer] Id of project
-          # @return [Hashie::Mash] Summary of all location groups in project
+          # @return [Hash] Summary of all location groups in project
           def location_groups_summary(project_id, opts = {})
             get "projects/#{project_id}/group/location/summary", opts
           end
@@ -16,7 +16,7 @@ module BWAPI
           #
           # @param project_id [Integer] Id of project
           # @param location_group_id [Integer] Id of location group
-          # @return [Hashie::Mash] Specific location group
+          # @return [Hash] Specific location group
           def get_location_group(project_id, location_group_id)
             get "projects/#{project_id}/group/location/#{location_group_id}"
           end
@@ -30,7 +30,7 @@ module BWAPI
           # @option opts [Array] sharedProjectIds The ids of the shared projects
           # @option opts [String] shared The type of sharing for the group
           # @option opts [Array] location The location in the group
-          # @return [Hashie::Mash] New location group
+          # @return [Hash] New location group
           def create_location_group(project_id, opts = {})
             post "projects/#{project_id}/group/location", opts
           end
@@ -46,7 +46,7 @@ module BWAPI
           # @option opts [Array] sharedProjectIds The ids of the shared projects
           # @option opts [String] shared The type of sharing for the group
           # @option opts [Array] location The location in the group
-          # @return [Hashie::Mash] Updated location group
+          # @return [Hash] Updated location group
           def update_location_group(project_id, location_group_id, opts = {})
             put "projects/#{project_id}/group/location/#{location_group_id}", opts
           end
@@ -55,7 +55,7 @@ module BWAPI
           #
           # @param project_id [Integer] Id of project
           # @param location_group_id [Integer] Id of location group
-          # @return [Hashie::Mash] Deleted location group
+          # @return [Hash] Deleted location group
           def delete_location_group(project_id, location_group_id)
             delete "projects/#{project_id}/group/location/#{location_group_id}"
           end

data/lib/bwapi/client/projects/group/site_group.rb

@@ -7,7 +7,7 @@ module BWAPI
           # Get summary of all site groups in project
           #
           # @param project_id [Integer] Id of project
-          # @return [Hashie::Mash] Summary of all site groups in project
+          # @return [Hash] Summary of all site groups in project
           def site_groups_summary(project_id, opts = {})
             get "projects/#{project_id}/group/site/summary", opts
           end
@@ -16,7 +16,7 @@ module BWAPI
           #
           # @param project_id [Integer] Id of project
           # @param site_group_id [Integer] Id of site group
-          # @return [Hashie::Mash] Specific site group
+          # @return [Hash] Specific site group
           def get_site_group(project_id, site_group_id)
             get "projects/#{project_id}/group/site/#{site_group_id}"
           end
@@ -30,7 +30,7 @@ module BWAPI
           # @option opts [Array] sharedProjectIds The ids of the shared projects
           # @option opts [String] shared The type of sharing for the group
           # @option opts [Array] sites The sites in the group
-          # @return [Hashie::Mash] New site group
+          # @return [Hash] New site group
           def create_site_group(project_id, opts = {})
             post "projects/#{project_id}/group/site", opts
           end
@@ -46,7 +46,7 @@ module BWAPI
           # @option opts [Array] sharedProjectIds The ids of the shared projects
           # @option opts [String] shared The type of sharing for the group
           # @option opts [Array] sites The sites in the group
-          # @return [Hashie::Mash] Updated site group
+          # @return [Hash] Updated site group
           def update_site_group(project_id, site_group_id, opts = {})
             put "projects/#{project_id}/group/site/#{site_group_id}", opts
           end
@@ -55,7 +55,7 @@ module BWAPI
           #
           # @param project_id [Integer] Id of project
           # @param site_group_id [Integer] Id of site group
-          # @return [Hashie::Mash] Deleted site group
+          # @return [Hash] Deleted site group
           def delete_site_group(project_id, site_group_id)
             delete "projects/#{project_id}/group/site/#{site_group_id}"
           end

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

@@ -15,7 +15,7 @@ module BWAPI
         # @option opts [Array] type types of query to filter by
         # @option opts [Integer] page Page of results to retrieve
         # @option opts [Integer] pageSize Results per page of results
-        # @return [Hashie::Mash] All queries in project
+        # @return [Hash] All queries in project
         def queries(project_id, opts = {})
           get "projects/#{project_id}/queries", opts
         end
@@ -23,7 +23,7 @@ module BWAPI
         # Get summary of all queries in project
         #
         # @param project_id [Integer] Id of project
-        # @return [Hashie::Mash] Summary of all queries in project
+        # @return [Hash] Summary of all queries in project
         def queries_summary(project_id)
           get "projects/#{project_id}/queries/summary"
         end
@@ -32,7 +32,7 @@ module BWAPI
         #
         # @param project_id [Integer] Id of project
         # @param query_id [Integer] Id of query
-        # @return [Hashie::Mash] Specific query
+        # @return [Hash] Specific query
         def get_query(project_id, query_id)
           get "projects/#{project_id}/queries/#{query_id}"
         end
@@ -55,7 +55,7 @@ module BWAPI
         # @option opts [String] industry Industry of the query
         # @option opts [Date] creationDate Date the query was created on
         # @option opts [Date] lastModificationDate Modification date of the query
-        # @return [Hashie::Mash] New query
+        # @return [Hash] New query
         def create_query(project_id, opts = {})
           post "projects/#{project_id}/queries", opts
         end
@@ -79,7 +79,7 @@ module BWAPI
         # @option opts [String] industry Industry of the query
         # @option opts [Date] creationDate Date the query was created on
         # @option opts [Date] lastModificationDate Modification date of the query
-        # @return [Hashie::Mash] Updated query
+        # @return [Hash] Updated query
         def update_query(project_id, query_id, opts = {})
           put "projects/#{project_id}/queries/#{query_id}", opts
         end
@@ -88,7 +88,7 @@ module BWAPI
         #
         # @param project_id [Integer] Id of project
         # @param query_id [Integer] Id of query
-        # @return [Hashie::Mash] Deleted query
+        # @return [Hash] Deleted query
         def delete_query(project_id, query_id)
           delete "projects/#{project_id}/queries/#{query_id}"
         end