centralindex 0.0.13 → 0.0.14

data/lib/CentralIndex.rb

@@ -74,6 +74,23 @@ class CentralIndex
   end
 
 
+  #
+  # Get all advertisers that have been updated from a give date for a given publisher
+  #
+  #  @param publisher_id
+  #  @param from_date
+  #  @param country
+  #  @return - the data from the api
+  #
+  def getAdvertiserUpdatedBy_publisher( publisher_id, from_date, country)
+    params = Hash.new
+    params['publisher_id'] = publisher_id
+    params['from_date'] = from_date
+    params['country'] = country
+    return doCurl("get","/advertiser/updated/by_publisher",params)
+  end
+
+
   #
   # The search matches a category name on a given string and language.
   #
@@ -109,28 +126,32 @@ class CentralIndex
   #
   #  @param str - A string to search against, E.g. Dub e.g. dub
   #  @param country - Which country to return results for. An ISO compatible country code, E.g. ie e.g. ie
+  #  @param language - An ISO compatible language code, E.g. en e.g. en
   #  @return - the data from the api
   #
-  def getAutocompleteLocation( str, country)
+  def getAutocompleteLocation( str, country, language)
     params = Hash.new
     params['str'] = str
     params['country'] = country
+    params['language'] = language
     return doCurl("get","/autocomplete/location",params)
   end
 
 
   #
-  # The search matches a postcode to the supplied string
+  # The search matches a location name or synonym on a given string and language.
   #
-  #  @param str - A string to search against, E.g. W1 e.g. W1
-  #  @param country - Which country to return results for. An ISO compatible country code, E.g. gb e.g. gb
+  #  @param str - A string to search against, E.g. Middle e.g. dub
+  #  @param country - Which country to return results for. An ISO compatible country code, E.g. ie e.g. ie
+  #  @param resolution
   #  @return - the data from the api
   #
-  def getAutocompletePostcode( str, country)
+  def getAutocompleteLocationBy_resolution( str, country, resolution)
     params = Hash.new
     params['str'] = str
     params['country'] = country
-    return doCurl("get","/autocomplete/postcode",params)
+    params['resolution'] = resolution
+    return doCurl("get","/autocomplete/location/by_resolution",params)
   end
 
 
@@ -152,14 +173,17 @@ class CentralIndex
   #  @param longitude
   #  @param timezone
   #  @param telephone_number
+  #  @param additional_telephone_number
   #  @param email
   #  @param website
   #  @param category_id
   #  @param category_type
   #  @param do_not_display
+  #  @param referrer_url
+  #  @param referrer_name
   #  @return - the data from the api
   #
-  def putBusiness( name, building_number, address1, address2, address3, district, town, county, province, postcode, country, latitude, longitude, timezone, telephone_number, email, website, category_id, category_type, do_not_display)
+  def putBusiness( name, building_number, address1, address2, address3, district, town, county, province, postcode, country, latitude, longitude, timezone, telephone_number, additional_telephone_number, email, website, category_id, category_type, do_not_display, referrer_url, referrer_name)
     params = Hash.new
     params['name'] = name
     params['building_number'] = building_number
@@ -176,25 +200,92 @@ class CentralIndex
     params['longitude'] = longitude
     params['timezone'] = timezone
     params['telephone_number'] = telephone_number
+    params['additional_telephone_number'] = additional_telephone_number
     params['email'] = email
     params['website'] = website
     params['category_id'] = category_id
     params['category_type'] = category_type
     params['do_not_display'] = do_not_display
+    params['referrer_url'] = referrer_url
+    params['referrer_name'] = referrer_name
     return doCurl("put","/business",params)
   end
 
 
   #
-  # Returns the supplied wolf category object by fetching the supplied category_id from our categories object.
+  # Delete a business tool with a specified tool_id
   #
-  #  @param category_id
+  #  @param tool_id
   #  @return - the data from the api
   #
-  def getCategory( category_id)
+  def deleteBusiness_tool( tool_id)
     params = Hash.new
-    params['category_id'] = category_id
-    return doCurl("get","/category",params)
+    params['tool_id'] = tool_id
+    return doCurl("delete","/business_tool",params)
+  end
+
+
+  #
+  # Update/Add a Business Tool
+  #
+  #  @param tool_id
+  #  @param country
+  #  @param headline
+  #  @param description
+  #  @param link_url
+  #  @param active
+  #  @return - the data from the api
+  #
+  def postBusiness_tool( tool_id, country, headline, description, link_url, active)
+    params = Hash.new
+    params['tool_id'] = tool_id
+    params['country'] = country
+    params['headline'] = headline
+    params['description'] = description
+    params['link_url'] = link_url
+    params['active'] = active
+    return doCurl("post","/business_tool",params)
+  end
+
+
+  #
+  # Returns business tool that matches a given tool id
+  #
+  #  @param tool_id
+  #  @return - the data from the api
+  #
+  def getBusiness_tool( tool_id)
+    params = Hash.new
+    params['tool_id'] = tool_id
+    return doCurl("get","/business_tool",params)
+  end
+
+
+  #
+  # Returns active business tools for a specific masheryid in a given country
+  #
+  #  @param country
+  #  @return - the data from the api
+  #
+  def getBusiness_toolBy_masheryid( country)
+    params = Hash.new
+    params['country'] = country
+    return doCurl("get","/business_tool/by_masheryid",params)
+  end
+
+
+  #
+  # Assigns a Business Tool image
+  #
+  #  @param tool_id
+  #  @param filedata
+  #  @return - the data from the api
+  #
+  def postBusiness_toolImage( tool_id, filedata)
+    params = Hash.new
+    params['tool_id'] = tool_id
+    params['filedata'] = filedata
+    return doCurl("post","/business_tool/image",params)
   end
 
 
@@ -215,6 +306,19 @@ class CentralIndex
   end
 
 
+  #
+  # Returns the supplied wolf category object by fetching the supplied category_id from our categories object.
+  #
+  #  @param category_id
+  #  @return - the data from the api
+  #
+  def getCategory( category_id)
+    params = Hash.new
+    params['category_id'] = category_id
+    return doCurl("get","/category",params)
+  end
+
+
   #
   # Returns all Central Index categories and associated data
   #
@@ -226,6 +330,23 @@ class CentralIndex
   end
 
 
+  #
+  # With a known category id, a mapping object can be deleted.
+  #
+  #  @param category_id
+  #  @param category_type
+  #  @param mapped_id
+  #  @return - the data from the api
+  #
+  def deleteCategoryMappings( category_id, category_type, mapped_id)
+    params = Hash.new
+    params['category_id'] = category_id
+    params['category_type'] = category_type
+    params['mapped_id'] = mapped_id
+    return doCurl("delete","/category/mappings",params)
+  end
+
+
   #
   # With a known category id, a mapping object can be added.
   #
@@ -261,36 +382,36 @@ class CentralIndex
 
 
   #
-  # With a known category id, a synonyms object can be removed.
+  # With a known category id, an synonym object can be added.
   #
   #  @param category_id
   #  @param synonym
   #  @param language
   #  @return - the data from the api
   #
-  def deleteCategorySynonym( category_id, synonym, language)
+  def postCategorySynonym( category_id, synonym, language)
     params = Hash.new
     params['category_id'] = category_id
     params['synonym'] = synonym
     params['language'] = language
-    return doCurl("delete","/category/synonym",params)
+    return doCurl("post","/category/synonym",params)
   end
 
 
   #
-  # With a known category id, an synonym object can be added.
+  # With a known category id, a synonyms object can be removed.
   #
   #  @param category_id
   #  @param synonym
   #  @param language
   #  @return - the data from the api
   #
-  def postCategorySynonym( category_id, synonym, language)
+  def deleteCategorySynonym( category_id, synonym, language)
     params = Hash.new
     params['category_id'] = category_id
     params['synonym'] = synonym
     params['language'] = language
-    return doCurl("post","/category/synonym",params)
+    return doCurl("delete","/category/synonym",params)
   end
 
 
@@ -319,9 +440,14 @@ class CentralIndex
   #  @param nokia_country_code
   #  @param twilio_sms
   #  @param twilio_phone
+  #  @param twilio_voice
+  #  @param currency_symbol - the symbol of this country's currency
+  #  @param currency_symbol_html - the html version of the symbol of this country's currency
+  #  @param postcodeLookupActive - Whether the lookup is activated for this country
+  #  @param addressFields - Whether fields are activated for this country
   #  @return - the data from the api
   #
-  def postCountry( country_id, name, synonyms, continentName, continent, geonameId, dbpediaURL, freebaseURL, population, currencyCode, languages, areaInSqKm, capital, east, west, north, south, claimPrice, claimMethods, nokia_country_code, twilio_sms, twilio_phone)
+  def postCountry( country_id, name, synonyms, continentName, continent, geonameId, dbpediaURL, freebaseURL, population, currencyCode, languages, areaInSqKm, capital, east, west, north, south, claimPrice, claimMethods, nokia_country_code, twilio_sms, twilio_phone, twilio_voice, currency_symbol, currency_symbol_html, postcodeLookupActive, addressFields)
     params = Hash.new
     params['country_id'] = country_id
     params['name'] = name
@@ -345,6 +471,11 @@ class CentralIndex
     params['nokia_country_code'] = nokia_country_code
     params['twilio_sms'] = twilio_sms
     params['twilio_phone'] = twilio_phone
+    params['twilio_voice'] = twilio_voice
+    params['currency_symbol'] = currency_symbol
+    params['currency_symbol_html'] = currency_symbol_html
+    params['postcodeLookupActive'] = postcodeLookupActive
+    params['addressFields'] = addressFields
     return doCurl("post","/country",params)
   end
 
@@ -362,6 +493,38 @@ class CentralIndex
   end
 
 
+  #
+  # For a given country add/update a background image to show in the add/edit path
+  #
+  #  @param country_id
+  #  @param filedata
+  #  @param backgroundImageAttr
+  #  @return - the data from the api
+  #
+  def postCountryBackgroundImage( country_id, filedata, backgroundImageAttr)
+    params = Hash.new
+    params['country_id'] = country_id
+    params['filedata'] = filedata
+    params['backgroundImageAttr'] = backgroundImageAttr
+    return doCurl("post","/country/backgroundImage",params)
+  end
+
+
+  #
+  # For a given country add/update a social login background image to show in the add/edit path
+  #
+  #  @param country_id
+  #  @param filedata
+  #  @return - the data from the api
+  #
+  def postCountrySocialLoginImage( country_id, filedata)
+    params = Hash.new
+    params['country_id'] = country_id
+    params['filedata'] = filedata
+    return doCurl("post","/country/socialLoginImage",params)
+  end
+
+
   #
   # Send an email via amazon
   #
@@ -385,6 +548,19 @@ class CentralIndex
   end
 
 
+  #
+  # Allows a whole entity to be pulled from the datastore by its unique id
+  #
+  #  @param entity_id - The unique entity ID e.g. 379236608286720
+  #  @return - the data from the api
+  #
+  def getEntity( entity_id)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    return doCurl("get","/entity",params)
+  end
+
+
   #
   # This entity isn't really supported anymore. You probably want PUT /business. Only to be used for testing.
   #
@@ -407,15 +583,19 @@ class CentralIndex
 
 
   #
-  # Allows a whole entity to be pulled from the datastore by its unique id
+  # With a known entity id, an add can be updated.
   #
-  #  @param entity_id - The unique entity ID e.g. 379236608286720
+  #  @param entity_id
+  #  @param add_referrer_url
+  #  @param add_referrer_name
   #  @return - the data from the api
   #
-  def getEntity( entity_id)
+  def postEntityAdd( entity_id, add_referrer_url, add_referrer_name)
     params = Hash.new
     params['entity_id'] = entity_id
-    return doCurl("get","/entity",params)
+    params['add_referrer_url'] = add_referrer_url
+    params['add_referrer_name'] = add_referrer_name
+    return doCurl("post","/entity/add",params)
   end
 
 
@@ -712,6 +892,19 @@ class CentralIndex
   end
 
 
+  #
+  # Get all entities within a specified group
+  #
+  #  @param group_id
+  #  @return - the data from the api
+  #
+  def getEntityBy_groupid( group_id)
+    params = Hash.new
+    params['group_id'] = group_id
+    return doCurl("get","/entity/by_groupid",params)
+  end
+
+
   #
   # Fetches the documents that match the given masheryid and supplier_id
   #
@@ -791,15 +984,19 @@ class CentralIndex
   #  @param claimed_date
   #  @param claim_method
   #  @param phone_number
+  #  @param referrer_url
+  #  @param referrer_name
   #  @return - the data from the api
   #
-  def postEntityClaim( entity_id, claimed_user_id, claimed_date, claim_method, phone_number)
+  def postEntityClaim( entity_id, claimed_user_id, claimed_date, claim_method, phone_number, referrer_url, referrer_name)
     params = Hash.new
     params['entity_id'] = entity_id
     params['claimed_user_id'] = claimed_user_id
     params['claimed_date'] = claimed_date
     params['claim_method'] = claim_method
     params['phone_number'] = phone_number
+    params['referrer_url'] = referrer_url
+    params['referrer_name'] = referrer_name
     return doCurl("post","/entity/claim",params)
   end
 
@@ -836,6 +1033,21 @@ class CentralIndex
   end
 
 
+  #
+  # Allows a phone object to be reduced in confidence
+  #
+  #  @param entity_id
+  #  @param gen_id
+  #  @return - the data from the api
+  #
+  def deleteEntityDocument( entity_id, gen_id)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['gen_id'] = gen_id
+    return doCurl("delete","/entity/document",params)
+  end
+
+
   #
   # With a known entity id, an document object can be added.
   #
@@ -854,17 +1066,19 @@ class CentralIndex
 
 
   #
-  # Allows a phone object to be reduced in confidence
+  # With a known entity id, an email address object can be added.
   #
   #  @param entity_id
-  #  @param gen_id
+  #  @param email_address
+  #  @param email_description
   #  @return - the data from the api
   #
-  def deleteEntityDocument( entity_id, gen_id)
+  def postEntityEmail( entity_id, email_address, email_description)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/entity/document",params)
+    params['email_address'] = email_address
+    params['email_description'] = email_description
+    return doCurl("post","/entity/email",params)
   end
 
 
@@ -884,19 +1098,17 @@ class CentralIndex
 
 
   #
-  # With a known entity id, an email address object can be added.
+  # Allows an employee object to be reduced in confidence
   #
   #  @param entity_id
-  #  @param email_address
-  #  @param email_description
+  #  @param gen_id
   #  @return - the data from the api
   #
-  def postEntityEmail( entity_id, email_address, email_description)
+  def deleteEntityEmployee( entity_id, gen_id)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['email_address'] = email_address
-    params['email_description'] = email_description
-    return doCurl("post","/entity/email",params)
+    params['gen_id'] = gen_id
+    return doCurl("delete","/entity/employee",params)
   end
 
 
@@ -927,21 +1139,6 @@ class CentralIndex
   end
 
 
-  #
-  # Allows an employee object to be reduced in confidence
-  #
-  #  @param entity_id
-  #  @param gen_id
-  #  @return - the data from the api
-  #
-  def deleteEntityEmployee( entity_id, gen_id)
-    params = Hash.new
-    params['entity_id'] = entity_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/entity/employee",params)
-  end
-
-
   #
   # Allows a fax object to be reduced in confidence
   #
@@ -1170,12 +1367,20 @@ class CentralIndex
   #
   #  @param from
   #  @param to
+  #  @param override_trust - Do you want to override the trust of the 'from' entity
+  #  @param uncontribute_masheryid - Do we want to uncontribute any data for a masheryid?
+  #  @param uncontribute_userid - Do we want to uncontribute any data for a user_id?
+  #  @param uncontribute_supplierid - Do we want to uncontribute any data for a supplier_id?
   #  @return - the data from the api
   #
-  def postEntityMerge( from, to)
+  def postEntityMerge( from, to, override_trust, uncontribute_masheryid, uncontribute_userid, uncontribute_supplierid)
     params = Hash.new
     params['from'] = from
     params['to'] = to
+    params['override_trust'] = override_trust
+    params['uncontribute_masheryid'] = uncontribute_masheryid
+    params['uncontribute_userid'] = uncontribute_userid
+    params['uncontribute_supplierid'] = uncontribute_supplierid
     return doCurl("post","/entity/merge",params)
   end
 
@@ -1246,19 +1451,15 @@ class CentralIndex
 
 
   #
-  # Allows a new phone object to be added to a specified entity. A new object id will be calculated and returned to you if successful.
+  # With a known entity id, a opening times object can be removed.
   #
-  #  @param entity_id
-  #  @param number
-  #  @param description
+  #  @param entity_id - The id of the entity to edit
   #  @return - the data from the api
   #
-  def postEntityPhone( entity_id, number, description)
+  def deleteEntityOpening_times( entity_id)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['number'] = number
-    params['description'] = description
-    return doCurl("post","/entity/phone",params)
+    return doCurl("delete","/entity/opening_times",params)
   end
 
 
@@ -1277,6 +1478,23 @@ class CentralIndex
   end
 
 
+  #
+  # Allows a new phone object to be added to a specified entity. A new object id will be calculated and returned to you if successful.
+  #
+  #  @param entity_id
+  #  @param number
+  #  @param description
+  #  @return - the data from the api
+  #
+  def postEntityPhone( entity_id, number, description)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['number'] = number
+    params['description'] = description
+    return doCurl("post","/entity/phone",params)
+  end
+
+
   #
   # Create/Update a postal address
   #
@@ -1312,6 +1530,19 @@ class CentralIndex
   end
 
 
+  #
+  # Fetches the documents that match the given masheryid and supplier_id
+  #
+  #  @param supplier_id - The Supplier ID
+  #  @return - the data from the api
+  #
+  def getEntityProvisionalBy_supplier_id( supplier_id)
+    params = Hash.new
+    params['supplier_id'] = supplier_id
+    return doCurl("get","/entity/provisional/by_supplier_id",params)
+  end
+
+
   #
   # Allows a list of available revisions to be returned by its entity id
   #
@@ -1404,15 +1635,19 @@ class CentralIndex
   #  @param page - What page number to retrieve
   #  @param country - Which country to return results for. An ISO compatible country code, E.g. ie
   #  @param language - An ISO compatible language code, E.g. en
+  #  @param latitude - The decimal latitude of the search context (optional)
+  #  @param longitude - The decimal longitude of the search context (optional)
   #  @return - the data from the api
   #
-  def getEntitySearchBylocation( where, per_page, page, country, language)
+  def getEntitySearchBylocation( where, per_page, page, country, language, latitude, longitude)
     params = Hash.new
     params['where'] = where
     params['per_page'] = per_page
     params['page'] = page
     params['country'] = country
     params['language'] = language
+    params['latitude'] = latitude
+    params['longitude'] = longitude
     return doCurl("get","/entity/search/bylocation",params)
   end
 
@@ -1476,9 +1711,11 @@ class CentralIndex
   #  @param page - Which page number to retrieve
   #  @param country - Which country to return results for. An ISO compatible country code, E.g. ie e.g. ie
   #  @param language - An ISO compatible language code, E.g. en
+  #  @param latitude - The decimal latitude of the search context (optional)
+  #  @param longitude - The decimal longitude of the search context (optional)
   #  @return - the data from the api
   #
-  def getEntitySearchWhatBylocation( what, where, per_page, page, country, language)
+  def getEntitySearchWhatBylocation( what, where, per_page, page, country, language, latitude, longitude)
     params = Hash.new
     params['what'] = what
     params['where'] = where
@@ -1486,6 +1723,8 @@ class CentralIndex
     params['page'] = page
     params['country'] = country
     params['language'] = language
+    params['latitude'] = latitude
+    params['longitude'] = longitude
     return doCurl("get","/entity/search/what/bylocation",params)
   end
 
@@ -1497,14 +1736,16 @@ class CentralIndex
   #  @param per_page - How many results per page
   #  @param page - What page number to retrieve
   #  @param country - Which country to return results for. An ISO compatible country code, E.g. ie e.g. ie
+  #  @param language - An ISO compatible language code, E.g. en
   #  @return - the data from the api
   #
-  def getEntitySearchWho( who, per_page, page, country)
+  def getEntitySearchWho( who, per_page, page, country, language)
     params = Hash.new
     params['who'] = who
     params['per_page'] = per_page
     params['page'] = page
     params['country'] = country
+    params['language'] = language
     return doCurl("get","/entity/search/who",params)
   end
 
@@ -1520,9 +1761,10 @@ class CentralIndex
   #  @param per_page
   #  @param page
   #  @param country
+  #  @param language - An ISO compatible language code, E.g. en
   #  @return - the data from the api
   #
-  def getEntitySearchWhoByboundingbox( who, latitude_1, longitude_1, latitude_2, longitude_2, per_page, page, country)
+  def getEntitySearchWhoByboundingbox( who, latitude_1, longitude_1, latitude_2, longitude_2, per_page, page, country, language)
     params = Hash.new
     params['who'] = who
     params['latitude_1'] = latitude_1
@@ -1532,6 +1774,7 @@ class CentralIndex
     params['per_page'] = per_page
     params['page'] = page
     params['country'] = country
+    params['language'] = language
     return doCurl("get","/entity/search/who/byboundingbox",params)
   end
 
@@ -1544,15 +1787,21 @@ class CentralIndex
   #  @param per_page - Number of results returned per page
   #  @param page - Which page number to retrieve
   #  @param country - Which country to return results for. An ISO compatible country code, E.g. ie e.g. ie
+  #  @param latitude - The decimal latitude of the search context (optional)
+  #  @param longitude - The decimal longitude of the search context (optional)
+  #  @param language - An ISO compatible language code, E.g. en
   #  @return - the data from the api
   #
-  def getEntitySearchWhoBylocation( who, where, per_page, page, country)
+  def getEntitySearchWhoBylocation( who, where, per_page, page, country, latitude, longitude, language)
     params = Hash.new
     params['who'] = who
     params['where'] = where
     params['per_page'] = per_page
     params['page'] = page
     params['country'] = country
+    params['latitude'] = latitude
+    params['longitude'] = longitude
+    params['language'] = language
     return doCurl("get","/entity/search/who/bylocation",params)
   end
 
@@ -1699,6 +1948,21 @@ class CentralIndex
   end
 
 
+  #
+  # Allows a testimonial object to be reduced in confidence
+  #
+  #  @param entity_id
+  #  @param gen_id
+  #  @return - the data from the api
+  #
+  def deleteEntityTestimonial( entity_id, gen_id)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['gen_id'] = gen_id
+    return doCurl("delete","/entity/testimonial",params)
+  end
+
+
   #
   # With a known entity id, a testimonial object can be added.
   #
@@ -1721,17 +1985,21 @@ class CentralIndex
 
 
   #
-  # Allows a testimonial object to be reduced in confidence
+  # Get the updates a uncontribute would perform
   #
-  #  @param entity_id
-  #  @param gen_id
+  #  @param entity_id - The entity to pull
+  #  @param object_name - The entity object to update
+  #  @param supplier_id - The supplier_id to remove
+  #  @param user_id - The user_id to remove
   #  @return - the data from the api
   #
-  def deleteEntityTestimonial( entity_id, gen_id)
+  def getEntityUncontribute( entity_id, object_name, supplier_id, user_id)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/entity/testimonial",params)
+    params['object_name'] = object_name
+    params['supplier_id'] = supplier_id
+    params['user_id'] = user_id
+    return doCurl("get","/entity/uncontribute",params)
   end
 
 
@@ -1833,6 +2101,19 @@ class CentralIndex
   end
 
 
+  #
+  # Get a flatpack
+  #
+  #  @param flatpack_id - the unique id to search for
+  #  @return - the data from the api
+  #
+  def getFlatpack( flatpack_id)
+    params = Hash.new
+    params['flatpack_id'] = flatpack_id
+    return doCurl("get","/flatpack",params)
+  end
+
+
   #
   # Remove a flatpack using a supplied flatpack_id
   #
@@ -1851,6 +2132,7 @@ class CentralIndex
   #
   #  @param flatpack_id - this record's unique, auto-generated id - if supplied, then this is an edit, otherwise it's an add
   #  @param domainName - the domain name to serve this flatpack site on (no leading http:// or anything please)
+  #  @param stub - the stub that is appended to the flatpack's url e.g. http://dev.localhost/stub
   #  @param flatpackName - the name of the Flat pack instance
   #  @param less - the LESS configuration to use to overrides the Bootstrap CSS
   #  @param language - the language in which to render the flatpack site
@@ -1877,6 +2159,7 @@ class CentralIndex
   #  @param bodyTop - the payload to put in the top of the body of a flatpack
   #  @param bodyBottom - the payload to put in the bottom of the body of a flatpack
   #  @param header_menu - the JSON that describes a navigation at the top of the page
+  #  @param header_menu_bottom - the JSON that describes a navigation below the masthead
   #  @param footer_menu - the JSON that describes a navigation at the bottom of the page
   #  @param bdpTitle - The page title of the entity business profile pages
   #  @param bdpDescription - The meta description of entity business profile pages
@@ -1886,6 +2169,8 @@ class CentralIndex
   #  @param serpNumberResults - The number of results per search page
   #  @param serpNumberAdverts - The number of adverts to show on the first search page
   #  @param serpAds - The block of HTML/JS that renders Ads on Serps
+  #  @param serpTitleNoWhat - The text to display in the title for where only searches
+  #  @param serpDescriptionNoWhat - The text to display in the description for where only searches
   #  @param cookiePolicyUrl - The cookie policy url of the flatpack
   #  @param cookiePolicyNotice - Whether to show the cookie policy on this flatpack
   #  @param addBusinessButtonText - The text used in the 'Add your business' button
@@ -1898,12 +2183,18 @@ class CentralIndex
   #  @param advertUpgradeMaxLocations - the number of locations upgrading gives you
   #  @param advertUpgradeContractLength - the length of the contract (days)
   #  @param advertUpgradeRefId - a unique reference for the upgrade
+  #  @param phoneReveal - record phone number reveal
+  #  @param loginLinkText - the link text for the Login link
+  #  @param contextLocationId - The location ID to use as the context for searches on this flatpack
+  #  @param addBusinessButtonPosition - The location ID to use as the context for searches on this flatpack
+  #  @param denyIndexing - Whether to noindex a flatpack
   #  @return - the data from the api
   #
-  def postFlatpack( flatpack_id, domainName, flatpackName, less, language, country, mapsType, mapKey, searchFormShowOn, searchFormShowKeywordsBox, searchFormShowLocationBox, searchFormKeywordsAutoComplete, searchFormLocationsAutoComplete, searchFormDefaultLocation, searchFormPlaceholderKeywords, searchFormPlaceholderLocation, searchFormKeywordsLabel, searchFormLocationLabel, cannedLinksHeader, homepageTitle, homepageDescription, homepageIntroTitle, homepageIntroText, head, adblock, bodyTop, bodyBottom, header_menu, footer_menu, bdpTitle, bdpDescription, bdpAds, serpTitle, serpDescription, serpNumberResults, serpNumberAdverts, serpAds, cookiePolicyUrl, cookiePolicyNotice, addBusinessButtonText, twitterUrl, facebookUrl, copyright, advertUpgradeActive, advertUpgradePrice, advertUpgradeMaxTags, advertUpgradeMaxLocations, advertUpgradeContractLength, advertUpgradeRefId)
+  def postFlatpack( flatpack_id, domainName, stub, flatpackName, less, language, country, mapsType, mapKey, searchFormShowOn, searchFormShowKeywordsBox, searchFormShowLocationBox, searchFormKeywordsAutoComplete, searchFormLocationsAutoComplete, searchFormDefaultLocation, searchFormPlaceholderKeywords, searchFormPlaceholderLocation, searchFormKeywordsLabel, searchFormLocationLabel, cannedLinksHeader, homepageTitle, homepageDescription, homepageIntroTitle, homepageIntroText, head, adblock, bodyTop, bodyBottom, header_menu, header_menu_bottom, footer_menu, bdpTitle, bdpDescription, bdpAds, serpTitle, serpDescription, serpNumberResults, serpNumberAdverts, serpAds, serpTitleNoWhat, serpDescriptionNoWhat, cookiePolicyUrl, cookiePolicyNotice, addBusinessButtonText, twitterUrl, facebookUrl, copyright, advertUpgradeActive, advertUpgradePrice, advertUpgradeMaxTags, advertUpgradeMaxLocations, advertUpgradeContractLength, advertUpgradeRefId, phoneReveal, loginLinkText, contextLocationId, addBusinessButtonPosition, denyIndexing)
     params = Hash.new
     params['flatpack_id'] = flatpack_id
     params['domainName'] = domainName
+    params['stub'] = stub
     params['flatpackName'] = flatpackName
     params['less'] = less
     params['language'] = language
@@ -1930,6 +2221,7 @@ class CentralIndex
     params['bodyTop'] = bodyTop
     params['bodyBottom'] = bodyBottom
     params['header_menu'] = header_menu
+    params['header_menu_bottom'] = header_menu_bottom
     params['footer_menu'] = footer_menu
     params['bdpTitle'] = bdpTitle
     params['bdpDescription'] = bdpDescription
@@ -1939,6 +2231,8 @@ class CentralIndex
     params['serpNumberResults'] = serpNumberResults
     params['serpNumberAdverts'] = serpNumberAdverts
     params['serpAds'] = serpAds
+    params['serpTitleNoWhat'] = serpTitleNoWhat
+    params['serpDescriptionNoWhat'] = serpDescriptionNoWhat
     params['cookiePolicyUrl'] = cookiePolicyUrl
     params['cookiePolicyNotice'] = cookiePolicyNotice
     params['addBusinessButtonText'] = addBusinessButtonText
@@ -1951,20 +2245,57 @@ class CentralIndex
     params['advertUpgradeMaxLocations'] = advertUpgradeMaxLocations
     params['advertUpgradeContractLength'] = advertUpgradeContractLength
     params['advertUpgradeRefId'] = advertUpgradeRefId
+    params['phoneReveal'] = phoneReveal
+    params['loginLinkText'] = loginLinkText
+    params['contextLocationId'] = contextLocationId
+    params['addBusinessButtonPosition'] = addBusinessButtonPosition
+    params['denyIndexing'] = denyIndexing
     return doCurl("post","/flatpack",params)
   end
 
 
   #
-  # Get a flatpack
+  # Upload a CSS file for the Admin for this flatpack
   #
-  #  @param flatpack_id - the unique id to search for
+  #  @param flatpack_id - the id of the flatpack to update
+  #  @param filedata
   #  @return - the data from the api
   #
-  def getFlatpack( flatpack_id)
+  def postFlatpackAdminCSS( flatpack_id, filedata)
     params = Hash.new
     params['flatpack_id'] = flatpack_id
-    return doCurl("get","/flatpack",params)
+    params['filedata'] = filedata
+    return doCurl("post","/flatpack/adminCSS",params)
+  end
+
+
+  #
+  # Upload an image to serve out as the large logo in the Admin for this flatpack
+  #
+  #  @param flatpack_id - the id of the flatpack to update
+  #  @param filedata
+  #  @return - the data from the api
+  #
+  def postFlatpackAdminLargeLogo( flatpack_id, filedata)
+    params = Hash.new
+    params['flatpack_id'] = flatpack_id
+    params['filedata'] = filedata
+    return doCurl("post","/flatpack/adminLargeLogo",params)
+  end
+
+
+  #
+  # Upload an image to serve out as the small logo in the Admin for this flatpack
+  #
+  #  @param flatpack_id - the id of the flatpack to update
+  #  @param filedata
+  #  @return - the data from the api
+  #
+  def postFlatpackAdminSmallLogo( flatpack_id, filedata)
+    params = Hash.new
+    params['flatpack_id'] = flatpack_id
+    params['filedata'] = filedata
+    return doCurl("post","/flatpack/adminSmallLogo",params)
   end
 
 
@@ -1993,32 +2324,32 @@ class CentralIndex
 
 
   #
-  # Upload an icon to serve out with this flatpack
+  # Clone an existing flatpack
   #
-  #  @param flatpack_id - the id of the flatpack to update
-  #  @param filedata
+  #  @param flatpack_id - the flatpack_id to clone
+  #  @param domainName - the domain of the new flatpack site (no leading http:// or anything please)
   #  @return - the data from the api
   #
-  def postFlatpackIcon( flatpack_id, filedata)
+  def getFlatpackClone( flatpack_id, domainName)
     params = Hash.new
     params['flatpack_id'] = flatpack_id
-    params['filedata'] = filedata
-    return doCurl("post","/flatpack/icon",params)
+    params['domainName'] = domainName
+    return doCurl("get","/flatpack/clone",params)
   end
 
 
   #
-  # Remove a canned link to an existing flatpack site.
+  # Upload an icon to serve out with this flatpack
   #
-  #  @param flatpack_id - the id of the flatpack to delete
-  #  @param gen_id - the id of the canned link to remove
+  #  @param flatpack_id - the id of the flatpack to update
+  #  @param filedata
   #  @return - the data from the api
   #
-  def deleteFlatpackLink( flatpack_id, gen_id)
+  def postFlatpackIcon( flatpack_id, filedata)
     params = Hash.new
     params['flatpack_id'] = flatpack_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/flatpack/link",params)
+    params['filedata'] = filedata
+    return doCurl("post","/flatpack/icon",params)
   end
 
 
@@ -2041,6 +2372,21 @@ class CentralIndex
   end
 
 
+  #
+  # Remove a canned link to an existing flatpack site.
+  #
+  #  @param flatpack_id - the id of the flatpack to delete
+  #  @param gen_id - the id of the canned link to remove
+  #  @return - the data from the api
+  #
+  def deleteFlatpackLink( flatpack_id, gen_id)
+    params = Hash.new
+    params['flatpack_id'] = flatpack_id
+    params['gen_id'] = gen_id
+    return doCurl("delete","/flatpack/link",params)
+  end
+
+
   #
   # Upload a logo to serve out with this flatpack
   #
@@ -2056,6 +2402,21 @@ class CentralIndex
   end
 
 
+  #
+  # Upload a TXT file to act as the sitemap for this flatpack
+  #
+  #  @param flatpack_id - the id of the flatpack to update
+  #  @param filedata
+  #  @return - the data from the api
+  #
+  def postFlatpackSitemap( flatpack_id, filedata)
+    params = Hash.new
+    params['flatpack_id'] = flatpack_id
+    params['filedata'] = filedata
+    return doCurl("post","/flatpack/sitemap",params)
+  end
+
+
   #
   # Upload a file to our asset server and return the url
   #
@@ -2114,6 +2475,130 @@ class CentralIndex
   end
 
 
+  #
+  # Bulk update entities with a specified group
+  #
+  #  @param group_id
+  #  @param data
+  #  @return - the data from the api
+  #
+  def postGroupBulk_update( group_id, data)
+    params = Hash.new
+    params['group_id'] = group_id
+    params['data'] = data
+    return doCurl("post","/group/bulk_update",params)
+  end
+
+
+  #
+  # Get number of claims today
+  #
+  #  @param from_date
+  #  @param to_date
+  #  @param country_id
+  #  @return - the data from the api
+  #
+  def getHeartbeatBy_date( from_date, to_date, country_id)
+    params = Hash.new
+    params['from_date'] = from_date
+    params['to_date'] = to_date
+    params['country_id'] = country_id
+    return doCurl("get","/heartbeat/by_date",params)
+  end
+
+
+  #
+  # Get number of claims today
+  #
+  #  @param country
+  #  @param claim_type
+  #  @return - the data from the api
+  #
+  def getHeartbeatTodayClaims( country, claim_type)
+    params = Hash.new
+    params['country'] = country
+    params['claim_type'] = claim_type
+    return doCurl("get","/heartbeat/today/claims",params)
+  end
+
+
+  #
+  # Process a bulk file
+  #
+  #  @param job_id
+  #  @param filedata - A tab separated file for ingest
+  #  @return - the data from the api
+  #
+  def postIngest_file( job_id, filedata)
+    params = Hash.new
+    params['job_id'] = job_id
+    params['filedata'] = filedata
+    return doCurl("post","/ingest_file",params)
+  end
+
+
+  #
+  # Get an ingest job from the collection
+  #
+  #  @param job_id
+  #  @return - the data from the api
+  #
+  def getIngest_job( job_id)
+    params = Hash.new
+    params['job_id'] = job_id
+    return doCurl("get","/ingest_job",params)
+  end
+
+
+  #
+  # Add a ingest job to the collection
+  #
+  #  @param description
+  #  @param category_type
+  #  @return - the data from the api
+  #
+  def postIngest_job( description, category_type)
+    params = Hash.new
+    params['description'] = description
+    params['category_type'] = category_type
+    return doCurl("post","/ingest_job",params)
+  end
+
+
+  #
+  # Get an ingest log from the collection
+  #
+  #  @param job_id
+  #  @param success
+  #  @param errors
+  #  @param limit
+  #  @param skip
+  #  @return - the data from the api
+  #
+  def getIngest_logBy_job_id( job_id, success, errors, limit, skip)
+    params = Hash.new
+    params['job_id'] = job_id
+    params['success'] = success
+    params['errors'] = errors
+    params['limit'] = limit
+    params['skip'] = skip
+    return doCurl("get","/ingest_log/by_job_id",params)
+  end
+
+
+  #
+  # Check the status of the Ingest queue, and potentially flush it
+  #
+  #  @param flush
+  #  @return - the data from the api
+  #
+  def getIngest_queue( flush)
+    params = Hash.new
+    params['flush'] = flush
+    return doCurl("get","/ingest_queue",params)
+  end
+
+
   #
   # Read a location with the supplied ID in the locations reference database.
   #
@@ -2128,20 +2613,20 @@ class CentralIndex
 
 
   #
-  # Create/update a new location entity with the supplied ID in the locations reference database.
+  # Create/update a new locz document with the supplied ID in the locations reference database.
   #
   #  @param location_id
+  #  @param type
+  #  @param country
+  #  @param language
   #  @param name
   #  @param formal_name
-  #  @param latitude
-  #  @param longitude
   #  @param resolution
-  #  @param country
   #  @param population
   #  @param description
   #  @param timezone
-  #  @param is_duplicate
-  #  @param is_default
+  #  @param latitude
+  #  @param longitude
   #  @param parent_town
   #  @param parent_county
   #  @param parent_province
@@ -2149,22 +2634,24 @@ class CentralIndex
   #  @param parent_neighbourhood
   #  @param parent_district
   #  @param postalcode
+  #  @param searchable_id
+  #  @param searchable_ids
   #  @return - the data from the api
   #
-  def postLocation( location_id, name, formal_name, latitude, longitude, resolution, country, population, description, timezone, is_duplicate, is_default, parent_town, parent_county, parent_province, parent_region, parent_neighbourhood, parent_district, postalcode)
+  def postLocation( location_id, type, country, language, name, formal_name, resolution, population, description, timezone, latitude, longitude, parent_town, parent_county, parent_province, parent_region, parent_neighbourhood, parent_district, postalcode, searchable_id, searchable_ids)
     params = Hash.new
     params['location_id'] = location_id
+    params['type'] = type
+    params['country'] = country
+    params['language'] = language
     params['name'] = name
     params['formal_name'] = formal_name
-    params['latitude'] = latitude
-    params['longitude'] = longitude
     params['resolution'] = resolution
-    params['country'] = country
     params['population'] = population
     params['description'] = description
     params['timezone'] = timezone
-    params['is_duplicate'] = is_duplicate
-    params['is_default'] = is_default
+    params['latitude'] = latitude
+    params['longitude'] = longitude
     params['parent_town'] = parent_town
     params['parent_county'] = parent_county
     params['parent_province'] = parent_province
@@ -2172,6 +2659,8 @@ class CentralIndex
     params['parent_neighbourhood'] = parent_neighbourhood
     params['parent_district'] = parent_district
     params['postalcode'] = postalcode
+    params['searchable_id'] = searchable_id
+    params['searchable_ids'] = searchable_ids
     return doCurl("post","/location",params)
   end
 
@@ -2190,55 +2679,15 @@ class CentralIndex
 
 
   #
-  # Add a new source to a known location
-  #
-  #  @param location_id
-  #  @param type
-  #  @param url
-  #  @param ref
-  #  @return - the data from the api
-  #
-  def postLocationSource( location_id, type, url, ref)
-    params = Hash.new
-    params['location_id'] = location_id
-    params['type'] = type
-    params['url'] = url
-    params['ref'] = ref
-    return doCurl("post","/location/source",params)
-  end
-
-
-  #
-  # Remove a new synonym from a known location
-  #
-  #  @param location_id
-  #  @param synonym
-  #  @param language
-  #  @return - the data from the api
-  #
-  def deleteLocationSynonym( location_id, synonym, language)
-    params = Hash.new
-    params['location_id'] = location_id
-    params['synonym'] = synonym
-    params['language'] = language
-    return doCurl("delete","/location/synonym",params)
-  end
-
-
-  #
-  # Add a new synonym to a known location
+  # Fetch the project logo, the symbol of the Wolf
   #
-  #  @param location_id
-  #  @param synonym
-  #  @param language
+  #  @param a
   #  @return - the data from the api
   #
-  def postLocationSynonym( location_id, synonym, language)
+  def putLogo( a)
     params = Hash.new
-    params['location_id'] = location_id
-    params['synonym'] = synonym
-    params['language'] = language
-    return doCurl("post","/location/synonym",params)
+    params['a'] = a
+    return doCurl("put","/logo",params)
   end
 
 
@@ -2261,19 +2710,6 @@ class CentralIndex
   end
 
 
-  #
-  # Fetch the project logo, the symbol of the Wolf
-  #
-  #  @param a
-  #  @return - the data from the api
-  #
-  def putLogo( a)
-    params = Hash.new
-    params['a'] = a
-    return doCurl("put","/logo",params)
-  end
-
-
   #
   # Find a category from cache or cloudant depending if it is in the cache
   #
@@ -2305,48 +2741,26 @@ class CentralIndex
 
 
   #
-  # Find a location from cache or cloudant depending if it is in the cache
+  # Find a location from cache or cloudant depending if it is in the cache (locz)
   #
   #  @param string
+  #  @param language
   #  @param country
+  #  @param latitude
+  #  @param longitude
   #  @return - the data from the api
   #
-  def getLookupLocation( string, country)
+  def getLookupLocation( string, language, country, latitude, longitude)
     params = Hash.new
     params['string'] = string
+    params['language'] = language
     params['country'] = country
+    params['latitude'] = latitude
+    params['longitude'] = longitude
     return doCurl("get","/lookup/location",params)
   end
 
 
-  #
-  # Find all the child locations of the selected location
-  #
-  #  @param location_id
-  #  @param resolution
-  #  @return - the data from the api
-  #
-  def getLookupLocationChildren( location_id, resolution)
-    params = Hash.new
-    params['location_id'] = location_id
-    params['resolution'] = resolution
-    return doCurl("get","/lookup/location/children",params)
-  end
-
-
-  #
-  # Find all the parents locations of the selected location
-  #
-  #  @param location_id
-  #  @return - the data from the api
-  #
-  def getLookupLocationParents( location_id)
-    params = Hash.new
-    params['location_id'] = location_id
-    return doCurl("get","/lookup/location/parents",params)
-  end
-
-
   #
   # Find all matches by location and then return all matches that also match company name. Default location_strictness is set to 7, which equates to +/- 20m
   #
@@ -2375,17 +2789,19 @@ class CentralIndex
   #  @param company_name
   #  @param latitude
   #  @param longitude
+  #  @param postcode
   #  @param country
   #  @param name_strictness
   #  @param location_strictness
   #  @return - the data from the api
   #
-  def getMatchByphone( phone, company_name, latitude, longitude, country, name_strictness, location_strictness)
+  def getMatchByphone( phone, company_name, latitude, longitude, postcode, country, name_strictness, location_strictness)
     params = Hash.new
     params['phone'] = phone
     params['company_name'] = company_name
     params['latitude'] = latitude
     params['longitude'] = longitude
+    params['postcode'] = postcode
     params['country'] = country
     params['name_strictness'] = name_strictness
     params['location_strictness'] = location_strictness
@@ -2393,6 +2809,19 @@ class CentralIndex
   end
 
 
+  #
+  # Fetching a message
+  #
+  #  @param message_id - The message id to pull the message for
+  #  @return - the data from the api
+  #
+  def getMessage( message_id)
+    params = Hash.new
+    params['message_id'] = message_id
+    return doCurl("get","/message",params)
+  end
+
+
   #
   # Update/Add a message
   #
@@ -2423,69 +2852,143 @@ class CentralIndex
 
 
   #
-  # Fetching a message
+  # Fetching messages by ses_id
+  #
+  #  @param ses_id - The amazon id to pull the message for
+  #  @return - the data from the api
+  #
+  def getMessageBy_ses_id( ses_id)
+    params = Hash.new
+    params['ses_id'] = ses_id
+    return doCurl("get","/message/by_ses_id",params)
+  end
+
+
+  #
+  # With a known entity id, a private object can be added.
+  #
+  #  @param entity_id - The entity to associate the private object with
+  #  @param data - The data to store
+  #  @return - the data from the api
+  #
+  def putPrivate_object( entity_id, data)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['data'] = data
+    return doCurl("put","/private_object",params)
+  end
+
+
+  #
+  # Allows a private object to be removed
+  #
+  #  @param private_object_id - The id of the private object to remove
+  #  @return - the data from the api
+  #
+  def deletePrivate_object( private_object_id)
+    params = Hash.new
+    params['private_object_id'] = private_object_id
+    return doCurl("delete","/private_object",params)
+  end
+
+
+  #
+  # Allows a private object to be returned based on the entity_id and masheryid
+  #
+  #  @param entity_id - The entity associated with the private object
+  #  @return - the data from the api
+  #
+  def getPrivate_objectAll( entity_id)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    return doCurl("get","/private_object/all",params)
+  end
+
+
+  #
+  # Perform the whole PTB process on the supplied entity
   #
-  #  @param message_id - The message id to pull the message for
+  #  @param entity_id
+  #  @param destructive
   #  @return - the data from the api
   #
-  def getMessage( message_id)
+  def getPtbAll( entity_id, destructive)
     params = Hash.new
-    params['message_id'] = message_id
-    return doCurl("get","/message",params)
+    params['entity_id'] = entity_id
+    params['destructive'] = destructive
+    return doCurl("get","/ptb/all",params)
   end
 
 
   #
-  # Fetching messages by ses_id
+  # Report on what happened to specific entity_id
   #
-  #  @param ses_id - The amazon id to pull the message for
+  #  @param year - the year to examine
+  #  @param month - the month to examine
+  #  @param entity_id - the entity to research
   #  @return - the data from the api
   #
-  def getMessageBy_ses_id( ses_id)
+  def getPtbLog( year, month, entity_id)
     params = Hash.new
-    params['ses_id'] = ses_id
-    return doCurl("get","/message/by_ses_id",params)
+    params['year'] = year
+    params['month'] = month
+    params['entity_id'] = entity_id
+    return doCurl("get","/ptb/log",params)
   end
 
 
   #
-  # With a known entity id, a private object can be added.
+  # Process an entity with a specific PTB module
   #
-  #  @param entity_id - The entity to associate the private object with
-  #  @param data - The data to store
+  #  @param entity_id
+  #  @param module
+  #  @param destructive
   #  @return - the data from the api
   #
-  def putPrivate_object( entity_id, data)
+  def getPtbModule( entity_id, module, destructive)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['data'] = data
-    return doCurl("put","/private_object",params)
+    params['module'] = module
+    params['destructive'] = destructive
+    return doCurl("get","/ptb/module",params)
   end
 
 
   #
-  # Allows a private object to be removed
+  # Report on the run-rate of the Paint the Bridge System
   #
-  #  @param private_object_id - The id of the private object to remove
+  #  @param country - the country to get the runrate for
+  #  @param year - the year to examine
+  #  @param month - the month to examine
+  #  @param day - the day to examine
   #  @return - the data from the api
   #
-  def deletePrivate_object( private_object_id)
+  def getPtbRunrate( country, year, month, day)
     params = Hash.new
-    params['private_object_id'] = private_object_id
-    return doCurl("delete","/private_object",params)
+    params['country'] = country
+    params['year'] = year
+    params['month'] = month
+    params['day'] = day
+    return doCurl("get","/ptb/runrate",params)
   end
 
 
   #
-  # Allows a private object to be returned based on the entity_id and masheryid
+  # Report on the value being added by Paint The Bridge
   #
-  #  @param entity_id - The entity associated with the private object
+  #  @param country - the country to get the runrate for
+  #  @param year - the year to examine
+  #  @param month - the month to examine
+  #  @param day - the day to examine
   #  @return - the data from the api
   #
-  def getPrivate_objectAll( entity_id)
+  def getPtbValueadded( country, year, month, day)
     params = Hash.new
-    params['entity_id'] = entity_id
-    return doCurl("get","/private_object/all",params)
+    params['country'] = country
+    params['year'] = year
+    params['month'] = month
+    params['day'] = day
+    return doCurl("get","/ptb/valueadded",params)
   end
 
 
@@ -2562,6 +3065,21 @@ class CentralIndex
   end
 
 
+  #
+  # Create a queue item
+  #
+  #  @param queue_name
+  #  @param data
+  #  @return - the data from the api
+  #
+  def putQueue( queue_name, data)
+    params = Hash.new
+    params['queue_name'] = queue_name
+    params['data'] = data
+    return doCurl("put","/queue",params)
+  end
+
+
   #
   # Retrieve queue items.
   #
@@ -2590,21 +3108,6 @@ class CentralIndex
   end
 
 
-  #
-  # Create a queue item
-  #
-  #  @param queue_name
-  #  @param data
-  #  @return - the data from the api
-  #
-  def putQueue( queue_name, data)
-    params = Hash.new
-    params['queue_name'] = queue_name
-    params['data'] = data
-    return doCurl("put","/queue",params)
-  end
-
-
   #
   # Add an error to a queue item
   #
@@ -2650,10 +3153,24 @@ class CentralIndex
   end
 
 
+  #
+  # Return a sales log by id
+  #
+  #  @param sales_log_id - The sales log id to pull
+  #  @return - the data from the api
+  #
+  def getSales_log( sales_log_id)
+    params = Hash.new
+    params['sales_log_id'] = sales_log_id
+    return doCurl("get","/sales_log",params)
+  end
+
+
   #
   # Log a sale
   #
   #  @param entity_id - The entity the sale was made against
+  #  @param country - The country code the sales log orginated
   #  @param action_type - The type of action we are performing
   #  @param publisher_id - The publisher id that has made the sale
   #  @param mashery_id - The mashery id
@@ -2666,9 +3183,10 @@ class CentralIndex
   #  @param expiry_date - The date the product expires
   #  @return - the data from the api
   #
-  def postSales_log( entity_id, action_type, publisher_id, mashery_id, reseller_ref, reseller_agent_id, max_tags, max_locations, extra_tags, extra_locations, expiry_date)
+  def postSales_log( entity_id, country, action_type, publisher_id, mashery_id, reseller_ref, reseller_agent_id, max_tags, max_locations, extra_tags, extra_locations, expiry_date)
     params = Hash.new
     params['entity_id'] = entity_id
+    params['country'] = country
     params['action_type'] = action_type
     params['publisher_id'] = publisher_id
     params['mashery_id'] = mashery_id
@@ -2686,13 +3204,32 @@ class CentralIndex
   #
   # Return a sales log by id
   #
-  #  @param sales_log_id - The sales log id to pull
+  #  @param from_date
+  #  @param country
+  #  @param action_type
   #  @return - the data from the api
   #
-  def getSales_log( sales_log_id)
+  def getSales_logBy_countryBy_date( from_date, country, action_type)
     params = Hash.new
-    params['sales_log_id'] = sales_log_id
-    return doCurl("get","/sales_log",params)
+    params['from_date'] = from_date
+    params['country'] = country
+    params['action_type'] = action_type
+    return doCurl("get","/sales_log/by_country/by_date",params)
+  end
+
+
+  #
+  # Return a sales log by id
+  #
+  #  @param from_date
+  #  @param to_date
+  #  @return - the data from the api
+  #
+  def getSales_logBy_date( from_date, to_date)
+    params = Hash.new
+    params['from_date'] = from_date
+    params['to_date'] = to_date
+    return doCurl("get","/sales_log/by_date",params)
   end
 
 
@@ -2700,14 +3237,16 @@ class CentralIndex
   # For insance, reporting a phone number as wrong
   #
   #  @param entity_id - A valid entity_id e.g. 379236608286720
+  #  @param country - The country code from where the signal originated e.g. ie
   #  @param gen_id - The gen_id for the item being reported
   #  @param signal_type - The signal that is to be reported e.g. wrong
   #  @param data_type - The type of data being reported
   #  @return - the data from the api
   #
-  def postSignal( entity_id, gen_id, signal_type, data_type)
+  def postSignal( entity_id, country, gen_id, signal_type, data_type)
     params = Hash.new
     params['entity_id'] = entity_id
+    params['country'] = country
     params['gen_id'] = gen_id
     params['signal_type'] = signal_type
     params['data_type'] = data_type
@@ -2732,6 +3271,21 @@ class CentralIndex
   end
 
 
+  #
+  # Get the stats on an entity in a given year
+  #
+  #  @param entity_id - A valid entity_id e.g. 379236608286720
+  #  @param year - The year to report on
+  #  @return - the data from the api
+  #
+  def getStatsEntityBy_year( entity_id, year)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['year'] = year
+    return doCurl("get","/stats/entity/by_year",params)
+  end
+
+
   #
   # Confirms that the API is active, and returns the current version number
   #
@@ -2749,13 +3303,15 @@ class CentralIndex
   #  @param language - The language to use to render the add path e.g. en
   #  @param portal_name - The name of the website that data is to be added on e.g. YourLocal
   #  @param country - The country of the entity to be added e.g. gb
+  #  @param flatpack_id - The id of the flatpack site where the request originated
   #  @return - the data from the api
   #
-  def getTokenAdd( language, portal_name, country)
+  def getTokenAdd( language, portal_name, country, flatpack_id)
     params = Hash.new
     params['language'] = language
     params['portal_name'] = portal_name
     params['country'] = country
+    params['flatpack_id'] = flatpack_id
     return doCurl("get","/token/add",params)
   end
 
@@ -2766,13 +3322,15 @@ class CentralIndex
   #  @param entity_id - Entity ID to be claimed e.g. 380348266819584
   #  @param language - The language to use to render the claim path e.g. en
   #  @param portal_name - The name of the website that entity is being claimed on e.g. YourLocal
+  #  @param flatpack_id - The id of the flatpack site where the request originated
   #  @return - the data from the api
   #
-  def getTokenClaim( entity_id, language, portal_name)
+  def getTokenClaim( entity_id, language, portal_name, flatpack_id)
     params = Hash.new
     params['entity_id'] = entity_id
     params['language'] = language
     params['portal_name'] = portal_name
+    params['flatpack_id'] = flatpack_id
     return doCurl("get","/token/claim",params)
   end
 
@@ -2790,17 +3348,38 @@ class CentralIndex
   end
 
 
+  #
+  # Fetch token for edit path
+  #
+  #  @param entity_id - The id of the entity being upgraded
+  #  @param language - The language for the app
+  #  @param flatpack_id - The id of the flatpack site where the request originated
+  #  @param edit_page - the page in the edit path that the user should land on
+  #  @return - the data from the api
+  #
+  def getTokenEdit( entity_id, language, flatpack_id, edit_page)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['language'] = language
+    params['flatpack_id'] = flatpack_id
+    params['edit_page'] = edit_page
+    return doCurl("get","/token/edit",params)
+  end
+
+
   #
   # Fetch token for login path
   #
   #  @param portal_name - The name of the application that has initiated the login process, example: 'Your Local'
   #  @param language - The language for the app
+  #  @param flatpack_id - The id of the flatpack site where the request originated
   #  @return - the data from the api
   #
-  def getTokenLogin( portal_name, language)
+  def getTokenLogin( portal_name, language, flatpack_id)
     params = Hash.new
     params['portal_name'] = portal_name
     params['language'] = language
+    params['flatpack_id'] = flatpack_id
     return doCurl("get","/token/login",params)
   end
 
@@ -2811,13 +3390,15 @@ class CentralIndex
   #  @param entity_id - The id of the entity being messaged
   #  @param portal_name - The name of the application that has initiated the email process, example: 'Your Local'
   #  @param language - The language for the app
+  #  @param flatpack_id - The id of the flatpack site where the request originated
   #  @return - the data from the api
   #
-  def getTokenMessage( entity_id, portal_name, language)
+  def getTokenMessage( entity_id, portal_name, language, flatpack_id)
     params = Hash.new
     params['entity_id'] = entity_id
     params['portal_name'] = portal_name
     params['language'] = language
+    params['flatpack_id'] = flatpack_id
     return doCurl("get","/token/message",params)
   end
 
@@ -2828,13 +3409,15 @@ class CentralIndex
   #  @param entity_id - The unique Entity ID e.g. 379236608286720
   #  @param portal_name - The name of the portal that the user is coming from e.g. YourLocal
   #  @param language - The language to use to render the report path
+  #  @param flatpack_id - The id of the flatpack site where the request originated
   #  @return - the data from the api
   #
-  def getTokenReport( entity_id, portal_name, language)
+  def getTokenReport( entity_id, portal_name, language, flatpack_id)
     params = Hash.new
     params['entity_id'] = entity_id
     params['portal_name'] = portal_name
     params['language'] = language
+    params['flatpack_id'] = flatpack_id
     return doCurl("get","/token/report",params)
   end
 
@@ -2850,9 +3433,10 @@ class CentralIndex
   #  @param max_locations - The number of locations attached to the advert
   #  @param contract_length - The number of days from the initial sale date that the contract is valid for
   #  @param ref_id - The campaign or reference id
+  #  @param flatpack_id - The id of the flatpack site where the request originated
   #  @return - the data from the api
   #
-  def getTokenUpgrade( entity_id, portal_name, language, price, max_tags, max_locations, contract_length, ref_id)
+  def getTokenUpgrade( entity_id, portal_name, language, price, max_tags, max_locations, contract_length, ref_id, flatpack_id)
     params = Hash.new
     params['entity_id'] = entity_id
     params['portal_name'] = portal_name
@@ -2862,6 +3446,7 @@ class CentralIndex
     params['max_locations'] = max_locations
     params['contract_length'] = contract_length
     params['ref_id'] = ref_id
+    params['flatpack_id'] = flatpack_id
     return doCurl("get","/token/upgrade",params)
   end
 
@@ -2957,6 +3542,21 @@ class CentralIndex
   end
 
 
+  #
+  # Given some image data we can resize and upload the images
+  #
+  #  @param filedata - The image data to upload and resize
+  #  @param type - The type of image to upload and resize
+  #  @return - the data from the api
+  #
+  def postToolsImage( filedata, type)
+    params = Hash.new
+    params['filedata'] = filedata
+    params['type'] = type
+    return doCurl("post","/tools/image",params)
+  end
+
+
   #
   # Generate JSON in the format to generate Mashery's IODocs
   #
@@ -2995,15 +3595,15 @@ class CentralIndex
   #  @param to - The phone number to verify
   #  @param from - The phone number to call from
   #  @param pin - The pin to verify the phone number with
-  #  @param language - The language to read the verification in
+  #  @param twilio_voice - The language to read the verification in
   #  @return - the data from the api
   #
-  def getToolsPhonecallVerify( to, from, pin, language)
+  def getToolsPhonecallVerify( to, from, pin, twilio_voice)
     params = Hash.new
     params['to'] = to
     params['from'] = from
     params['pin'] = pin
-    params['language'] = language
+    params['twilio_voice'] = twilio_voice
     return doCurl("get","/tools/phonecall/verify",params)
   end
 
@@ -3147,15 +3747,41 @@ class CentralIndex
 
 
   #
-  # Fetching a traction
+  # Update/Add a traction
   #
   #  @param traction_id
+  #  @param trigger_type
+  #  @param action_type
+  #  @param country
+  #  @param email_addresses
+  #  @param title
+  #  @param body
+  #  @param api_method
+  #  @param api_url
+  #  @param api_params
+  #  @param active
+  #  @param reseller_masheryid
+  #  @param publisher_masheryid
+  #  @param description
   #  @return - the data from the api
   #
-  def getTraction( traction_id)
+  def postTraction( traction_id, trigger_type, action_type, country, email_addresses, title, body, api_method, api_url, api_params, active, reseller_masheryid, publisher_masheryid, description)
     params = Hash.new
     params['traction_id'] = traction_id
-    return doCurl("get","/traction",params)
+    params['trigger_type'] = trigger_type
+    params['action_type'] = action_type
+    params['country'] = country
+    params['email_addresses'] = email_addresses
+    params['title'] = title
+    params['body'] = body
+    params['api_method'] = api_method
+    params['api_url'] = api_url
+    params['api_params'] = api_params
+    params['active'] = active
+    params['reseller_masheryid'] = reseller_masheryid
+    params['publisher_masheryid'] = publisher_masheryid
+    params['description'] = description
+    return doCurl("post","/traction",params)
   end
 
 
@@ -3173,35 +3799,15 @@ class CentralIndex
 
 
   #
-  # Update/Add a traction
+  # Fetching a traction
   #
   #  @param traction_id
-  #  @param trigger_type
-  #  @param action_type
-  #  @param country
-  #  @param email_addresses
-  #  @param title
-  #  @param body
-  #  @param api_method
-  #  @param api_url
-  #  @param api_params
-  #  @param active
   #  @return - the data from the api
   #
-  def postTraction( traction_id, trigger_type, action_type, country, email_addresses, title, body, api_method, api_url, api_params, active)
+  def getTraction( traction_id)
     params = Hash.new
     params['traction_id'] = traction_id
-    params['trigger_type'] = trigger_type
-    params['action_type'] = action_type
-    params['country'] = country
-    params['email_addresses'] = email_addresses
-    params['title'] = title
-    params['body'] = body
-    params['api_method'] = api_method
-    params['api_url'] = api_url
-    params['api_params'] = api_params
-    params['active'] = active
-    return doCurl("post","/traction",params)
+    return doCurl("get","/traction",params)
   end
 
 
@@ -3327,23 +3933,11 @@ class CentralIndex
   end
 
 
-  #
-  # With a unique ID address an user can be retrieved
-  #
-  #  @param user_id
-  #  @return - the data from the api
-  #
-  def getUser( user_id)
-    params = Hash.new
-    params['user_id'] = user_id
-    return doCurl("get","/user",params)
-  end
-
-
   #
   # Update user based on email address or social_network/social_network_id
   #
   #  @param email
+  #  @param user_id
   #  @param first_name
   #  @param last_name
   #  @param active
@@ -3353,11 +3947,14 @@ class CentralIndex
   #  @param social_network
   #  @param social_network_id
   #  @param reseller_admin_masheryid
+  #  @param group_id
+  #  @param admin_upgrader
   #  @return - the data from the api
   #
-  def postUser( email, first_name, last_name, active, trust, creation_date, user_type, social_network, social_network_id, reseller_admin_masheryid)
+  def postUser( email, user_id, first_name, last_name, active, trust, creation_date, user_type, social_network, social_network_id, reseller_admin_masheryid, group_id, admin_upgrader)
     params = Hash.new
     params['email'] = email
+    params['user_id'] = user_id
     params['first_name'] = first_name
     params['last_name'] = last_name
     params['active'] = active
@@ -3367,10 +3964,25 @@ class CentralIndex
     params['social_network'] = social_network
     params['social_network_id'] = social_network_id
     params['reseller_admin_masheryid'] = reseller_admin_masheryid
+    params['group_id'] = group_id
+    params['admin_upgrader'] = admin_upgrader
     return doCurl("post","/user",params)
   end
 
 
+  #
+  # With a unique ID address an user can be retrieved
+  #
+  #  @param user_id
+  #  @return - the data from the api
+  #
+  def getUser( user_id)
+    params = Hash.new
+    params['user_id'] = user_id
+    return doCurl("get","/user",params)
+  end
+
+
   #
   # With a unique email address an user can be retrieved
   #
@@ -3384,6 +3996,19 @@ class CentralIndex
   end
 
 
+  #
+  # Returns all the users that match the supplied group_id
+  #
+  #  @param group_id
+  #  @return - the data from the api
+  #
+  def getUserBy_groupid( group_id)
+    params = Hash.new
+    params['group_id'] = group_id
+    return doCurl("get","/user/by_groupid",params)
+  end
+
+
   #
   # Returns all the users that match the supplied reseller_admin_masheryid
   #
@@ -3412,6 +4037,19 @@ class CentralIndex
   end
 
 
+  #
+  # Removes group_admin privileges from a specified user
+  #
+  #  @param user_id
+  #  @return - the data from the api
+  #
+  def postUserGroup_admin_remove( user_id)
+    params = Hash.new
+    params['user_id'] = user_id
+    return doCurl("post","/user/group_admin_remove",params)
+  end
+
+
   #
   # Removes reseller privileges from a specified user
   #
@@ -3425,5 +4063,24 @@ class CentralIndex
   end
 
 
+  #
+  # Shows what would be emitted by a view, given a document
+  #
+  #  @param database - the database being worked on e.g. entities
+  #  @param designdoc - the design document containing the view e.g. _design/report
+  #  @param view - the name of the view to be tested e.g. bydate
+  #  @param doc - the JSON document to be analysed e.g. {}
+  #  @return - the data from the api
+  #
+  def getViewhelper( database, designdoc, view, doc)
+    params = Hash.new
+    params['database'] = database
+    params['designdoc'] = designdoc
+    params['view'] = view
+    params['doc'] = doc
+    return doCurl("get","/viewhelper",params)
+  end
+
+
 end