centralindex 0.0.14 → 0.0.15

data/lib/CentralIndex.rb

@@ -59,6 +59,54 @@ class CentralIndex
   end
 
 
+  #
+  # Get the activity from the collection
+  #
+  #  @param type - The activity type
+  #  @param country - The country to filter by
+  #  @param latitude_1 - The latitude_1 to filter by
+  #  @param longitude_1 - The longitude_1 to filter by
+  #  @param latitude_2 - The latitude_2 to filter by
+  #  @param longitude_2 - The longitude_2 to filter by
+  #  @param number_results - The number_results to filter by
+  #  @return - the data from the api
+  #
+  def getActivity_stream( type, country, latitude_1, longitude_1, latitude_2, longitude_2, number_results)
+    params = Hash.new
+    params['type'] = type
+    params['country'] = country
+    params['latitude_1'] = latitude_1
+    params['longitude_1'] = longitude_1
+    params['latitude_2'] = latitude_2
+    params['longitude_2'] = longitude_2
+    params['number_results'] = number_results
+    return doCurl("get","/activity_stream",params)
+  end
+
+
+  #
+  # When we get some activity make a record of it
+  #
+  #  @param entity_id - The entity to pull
+  #  @param entity_name - The entity name this entry refers to
+  #  @param type - The activity type
+  #  @param country - The country for the activity
+  #  @param longitude - The longitude for teh activity
+  #  @param latitude - The latitude for teh activity
+  #  @return - the data from the api
+  #
+  def postActivity_stream( entity_id, entity_name, type, country, longitude, latitude)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['entity_name'] = entity_name
+    params['type'] = type
+    params['country'] = country
+    params['longitude'] = longitude
+    params['latitude'] = latitude
+    return doCurl("post","/activity_stream",params)
+  end
+
+
   #
   # Get all advertisers that have been updated from a give date for a given reseller
   #
@@ -212,19 +260,6 @@ class CentralIndex
   end
 
 
-  #
-  # Delete a business tool with a specified tool_id
-  #
-  #  @param tool_id
-  #  @return - the data from the api
-  #
-  def deleteBusiness_tool( tool_id)
-    params = Hash.new
-    params['tool_id'] = tool_id
-    return doCurl("delete","/business_tool",params)
-  end
-
-
   #
   # Update/Add a Business Tool
   #
@@ -248,6 +283,19 @@ class CentralIndex
   end
 
 
+  #
+  # Delete a business tool with a specified tool_id
+  #
+  #  @param tool_id
+  #  @return - the data from the api
+  #
+  def deleteBusiness_tool( tool_id)
+    params = Hash.new
+    params['tool_id'] = tool_id
+    return doCurl("delete","/business_tool",params)
+  end
+
+
   #
   # Returns business tool that matches a given tool id
   #
@@ -382,36 +430,36 @@ class CentralIndex
 
 
   #
-  # 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
 
 
   #
-  # 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
 
 
@@ -779,6 +827,21 @@ class CentralIndex
   end
 
 
+  #
+  # Allows an affiliate link object to be reduced in confidence
+  #
+  #  @param entity_id
+  #  @param gen_id
+  #  @return - the data from the api
+  #
+  def deleteEntityAffiliate_link( entity_id, gen_id)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['gen_id'] = gen_id
+    return doCurl("delete","/entity/affiliate_link",params)
+  end
+
+
   #
   # With a known entity id, an affiliate link object can be added.
   #
@@ -800,21 +863,6 @@ class CentralIndex
   end
 
 
-  #
-  # Allows an affiliate link object to be reduced in confidence
-  #
-  #  @param entity_id
-  #  @param gen_id
-  #  @return - the data from the api
-  #
-  def deleteEntityAffiliate_link( entity_id, gen_id)
-    params = Hash.new
-    params['entity_id'] = entity_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/entity/affiliate_link",params)
-  end
-
-
   #
   # With a known entity id, an background object can be added. There can however only be one background object.
   #
@@ -932,34 +980,34 @@ class CentralIndex
 
 
   #
-  # Allows a category object to be reduced in confidence
+  # With a known entity id, an category object can be added.
   #
   #  @param entity_id
-  #  @param gen_id
+  #  @param category_id
+  #  @param category_type
   #  @return - the data from the api
   #
-  def deleteEntityCategory( entity_id, gen_id)
+  def postEntityCategory( entity_id, category_id, category_type)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/entity/category",params)
+    params['category_id'] = category_id
+    params['category_type'] = category_type
+    return doCurl("post","/entity/category",params)
   end
 
 
   #
-  # With a known entity id, an category object can be added.
+  # Allows a category object to be reduced in confidence
   #
   #  @param entity_id
-  #  @param category_id
-  #  @param category_type
+  #  @param gen_id
   #  @return - the data from the api
   #
-  def postEntityCategory( entity_id, category_id, category_type)
+  def deleteEntityCategory( entity_id, gen_id)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['category_id'] = category_id
-    params['category_type'] = category_type
-    return doCurl("post","/entity/category",params)
+    params['gen_id'] = gen_id
+    return doCurl("delete","/entity/category",params)
   end
 
 
@@ -1066,34 +1114,34 @@ class CentralIndex
 
 
   #
-  # With a known entity id, an email address object can be added.
+  # Allows a email 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 deleteEntityEmail( 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/email",params)
   end
 
 
   #
-  # Allows a email 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 deleteEntityEmail( 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/email",params)
+    params['email_address'] = email_address
+    params['email_description'] = email_description
+    return doCurl("post","/entity/email",params)
   end
 
 
@@ -1140,34 +1188,34 @@ class CentralIndex
 
 
   #
-  # Allows a fax object to be reduced in confidence
+  # With a known entity id, an fax object can be added.
   #
   #  @param entity_id
-  #  @param gen_id
+  #  @param number
+  #  @param description
   #  @return - the data from the api
   #
-  def deleteEntityFax( entity_id, gen_id)
+  def postEntityFax( entity_id, number, description)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/entity/fax",params)
+    params['number'] = number
+    params['description'] = description
+    return doCurl("post","/entity/fax",params)
   end
 
 
   #
-  # With a known entity id, an fax object can be added.
+  # Allows a fax object to be reduced in confidence
   #
   #  @param entity_id
-  #  @param number
-  #  @param description
+  #  @param gen_id
   #  @return - the data from the api
   #
-  def postEntityFax( entity_id, number, description)
+  def deleteEntityFax( entity_id, gen_id)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['number'] = number
-    params['description'] = description
-    return doCurl("post","/entity/fax",params)
+    params['gen_id'] = gen_id
+    return doCurl("delete","/entity/fax",params)
   end
 
 
@@ -1190,21 +1238,6 @@ class CentralIndex
   end
 
 
-  #
-  # With a known entity id, a group  can be added to group members.
-  #
-  #  @param entity_id
-  #  @param group_id
-  #  @return - the data from the api
-  #
-  def postEntityGroup( entity_id, group_id)
-    params = Hash.new
-    params['entity_id'] = entity_id
-    params['group_id'] = group_id
-    return doCurl("post","/entity/group",params)
-  end
-
-
   #
   # Allows a group object to be removed from an entities group members
   #
@@ -1221,19 +1254,17 @@ class CentralIndex
 
 
   #
-  # With a known entity id, a image object can be added.
+  # With a known entity id, a group  can be added to group members.
   #
   #  @param entity_id
-  #  @param filedata
-  #  @param image_name
+  #  @param group_id
   #  @return - the data from the api
   #
-  def postEntityImage( entity_id, filedata, image_name)
+  def postEntityGroup( entity_id, group_id)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['filedata'] = filedata
-    params['image_name'] = image_name
-    return doCurl("post","/entity/image",params)
+    params['group_id'] = group_id
+    return doCurl("post","/entity/group",params)
   end
 
 
@@ -1253,15 +1284,19 @@ class CentralIndex
 
 
   #
-  # With a known entity id and a known invoice_address ID, we can delete a specific invoice_address object from an enitity.
+  # With a known entity id, a image object can be added.
   #
   #  @param entity_id
+  #  @param filedata
+  #  @param image_name
   #  @return - the data from the api
   #
-  def deleteEntityInvoice_address( entity_id)
+  def postEntityImage( entity_id, filedata, image_name)
     params = Hash.new
     params['entity_id'] = entity_id
-    return doCurl("delete","/entity/invoice_address",params)
+    params['filedata'] = filedata
+    params['image_name'] = image_name
+    return doCurl("post","/entity/image",params)
   end
 
 
@@ -1299,17 +1334,15 @@ class CentralIndex
 
 
   #
-  # Allows a list description object to be reduced in confidence
+  # With a known entity id and a known invoice_address ID, we can delete a specific invoice_address object from an enitity.
   #
-  #  @param gen_id
   #  @param entity_id
   #  @return - the data from the api
   #
-  def deleteEntityList( gen_id, entity_id)
+  def deleteEntityInvoice_address( entity_id)
     params = Hash.new
-    params['gen_id'] = gen_id
     params['entity_id'] = entity_id
-    return doCurl("delete","/entity/list",params)
+    return doCurl("delete","/entity/invoice_address",params)
   end
 
 
@@ -1331,19 +1364,17 @@ class CentralIndex
 
 
   #
-  # With a known entity id, a logo object can be added.
+  # Allows a list description object to be reduced in confidence
   #
+  #  @param gen_id
   #  @param entity_id
-  #  @param filedata
-  #  @param logo_name
   #  @return - the data from the api
   #
-  def postEntityLogo( entity_id, filedata, logo_name)
+  def deleteEntityList( gen_id, entity_id)
     params = Hash.new
+    params['gen_id'] = gen_id
     params['entity_id'] = entity_id
-    params['filedata'] = filedata
-    params['logo_name'] = logo_name
-    return doCurl("post","/entity/logo",params)
+    return doCurl("delete","/entity/list",params)
   end
 
 
@@ -1362,6 +1393,23 @@ class CentralIndex
   end
 
 
+  #
+  # With a known entity id, a logo object can be added.
+  #
+  #  @param entity_id
+  #  @param filedata
+  #  @param logo_name
+  #  @return - the data from the api
+  #
+  def postEntityLogo( entity_id, filedata, logo_name)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['filedata'] = filedata
+    params['logo_name'] = logo_name
+    return doCurl("post","/entity/logo",params)
+  end
+
+
   #
   # Merge two entities into one
   #
@@ -1464,34 +1512,34 @@ class CentralIndex
 
 
   #
-  # Allows a phone object to be reduced in confidence
+  # 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 gen_id
+  #  @param number
+  #  @param description
   #  @return - the data from the api
   #
-  def deleteEntityPhone( entity_id, gen_id)
+  def postEntityPhone( entity_id, number, description)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/entity/phone",params)
+    params['number'] = number
+    params['description'] = description
+    return doCurl("post","/entity/phone",params)
   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.
+  # Allows a phone object to be reduced in confidence
   #
   #  @param entity_id
-  #  @param number
-  #  @param description
+  #  @param gen_id
   #  @return - the data from the api
   #
-  def postEntityPhone( entity_id, number, description)
+  def deleteEntityPhone( entity_id, gen_id)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['number'] = number
-    params['description'] = description
-    return doCurl("post","/entity/phone",params)
+    params['gen_id'] = gen_id
+    return doCurl("delete","/entity/phone",params)
   end
 
 
@@ -1571,35 +1619,6 @@ class CentralIndex
   end
 
 
-  #
-  # Search for matching entities
-  #
-  #  @param what
-  #  @param entity_name
-  #  @param where
-  #  @param per_page
-  #  @param page
-  #  @param longitude
-  #  @param latitude
-  #  @param country
-  #  @param language
-  #  @return - the data from the api
-  #
-  def getEntitySearch( what, entity_name, where, per_page, page, longitude, latitude, country, language)
-    params = Hash.new
-    params['what'] = what
-    params['entity_name'] = entity_name
-    params['where'] = where
-    params['per_page'] = per_page
-    params['page'] = page
-    params['longitude'] = longitude
-    params['latitude'] = latitude
-    params['country'] = country
-    params['language'] = language
-    return doCurl("get","/entity/search",params)
-  end
-
-
   #
   # Search for matching entities
   #
@@ -1827,23 +1846,6 @@ class CentralIndex
   end
 
 
-  #
-  # With a known entity id, a social media object can be added.
-  #
-  #  @param entity_id
-  #  @param type
-  #  @param website_url
-  #  @return - the data from the api
-  #
-  def postEntitySocialmedia( entity_id, type, website_url)
-    params = Hash.new
-    params['entity_id'] = entity_id
-    params['type'] = type
-    params['website_url'] = website_url
-    return doCurl("post","/entity/socialmedia",params)
-  end
-
-
   #
   # Allows a social media object to be reduced in confidence
   #
@@ -1860,17 +1862,19 @@ class CentralIndex
 
 
   #
-  # Allows a special offer object to be reduced in confidence
+  # With a known entity id, a social media object can be added.
   #
   #  @param entity_id
-  #  @param gen_id
+  #  @param type
+  #  @param website_url
   #  @return - the data from the api
   #
-  def deleteEntitySpecial_offer( entity_id, gen_id)
+  def postEntitySocialmedia( entity_id, type, website_url)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/entity/special_offer",params)
+    params['type'] = type
+    params['website_url'] = website_url
+    return doCurl("post","/entity/socialmedia",params)
   end
 
 
@@ -1901,17 +1905,36 @@ class CentralIndex
   end
 
 
+  #
+  # Allows a special offer object to be reduced in confidence
+  #
+  #  @param entity_id
+  #  @param gen_id
+  #  @return - the data from the api
+  #
+  def deleteEntitySpecial_offer( entity_id, gen_id)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['gen_id'] = gen_id
+    return doCurl("delete","/entity/special_offer",params)
+  end
+
+
   #
   # With a known entity id, a status object can be updated.
   #
   #  @param entity_id
   #  @param status
+  #  @param inactive_reason
+  #  @param inactive_description
   #  @return - the data from the api
   #
-  def postEntityStatus( entity_id, status)
+  def postEntityStatus( entity_id, status, inactive_reason, inactive_description)
     params = Hash.new
     params['entity_id'] = entity_id
     params['status'] = status
+    params['inactive_reason'] = inactive_reason
+    params['inactive_description'] = inactive_description
     return doCurl("post","/entity/status",params)
   end
 
@@ -1948,21 +1971,6 @@ 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.
   #
@@ -1984,6 +1992,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
+
+
   #
   # Get the updates a uncontribute would perform
   #
@@ -2354,36 +2377,36 @@ class CentralIndex
 
 
   #
-  # Add a canned link to an existing flatpack site.
+  # Remove a canned link to an existing flatpack site.
   #
   #  @param flatpack_id - the id of the flatpack to delete
-  #  @param keywords - the keywords to use in the canned search
-  #  @param location - the location to use in the canned search
-  #  @param linkText - the link text to be used to in the canned search link
+  #  @param gen_id - the id of the canned link to remove
   #  @return - the data from the api
   #
-  def postFlatpackLink( flatpack_id, keywords, location, linkText)
+  def deleteFlatpackLink( flatpack_id, gen_id)
     params = Hash.new
     params['flatpack_id'] = flatpack_id
-    params['keywords'] = keywords
-    params['location'] = location
-    params['linkText'] = linkText
-    return doCurl("post","/flatpack/link",params)
+    params['gen_id'] = gen_id
+    return doCurl("delete","/flatpack/link",params)
   end
 
 
   #
-  # Remove a canned link to an existing flatpack site.
+  # Add 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
+  #  @param keywords - the keywords to use in the canned search
+  #  @param location - the location to use in the canned search
+  #  @param linkText - the link text to be used to in the canned search link
   #  @return - the data from the api
   #
-  def deleteFlatpackLink( flatpack_id, gen_id)
+  def postFlatpackLink( flatpack_id, keywords, location, linkText)
     params = Hash.new
     params['flatpack_id'] = flatpack_id
-    params['gen_id'] = gen_id
-    return doCurl("delete","/flatpack/link",params)
+    params['keywords'] = keywords
+    params['location'] = location
+    params['linkText'] = linkText
+    return doCurl("post","/flatpack/link",params)
   end
 
 
@@ -2430,6 +2453,19 @@ class CentralIndex
   end
 
 
+  #
+  # Returns group that matches a given group id
+  #
+  #  @param group_id
+  #  @return - the data from the api
+  #
+  def getGroup( group_id)
+    params = Hash.new
+    params['group_id'] = group_id
+    return doCurl("get","/group",params)
+  end
+
+
   #
   # Update/Add a Group
   #
@@ -2462,19 +2498,6 @@ class CentralIndex
   end
 
 
-  #
-  # Returns group that matches a given group id
-  #
-  #  @param group_id
-  #  @return - the data from the api
-  #
-  def getGroup( group_id)
-    params = Hash.new
-    params['group_id'] = group_id
-    return doCurl("get","/group",params)
-  end
-
-
   #
   # Bulk update entities with a specified group
   #
@@ -2538,30 +2561,30 @@ class CentralIndex
 
 
   #
-  # Get an ingest job from the collection
+  # Add a ingest job to the collection
   #
-  #  @param job_id
+  #  @param description
+  #  @param category_type
   #  @return - the data from the api
   #
-  def getIngest_job( job_id)
+  def postIngest_job( description, category_type)
     params = Hash.new
-    params['job_id'] = job_id
-    return doCurl("get","/ingest_job",params)
+    params['description'] = description
+    params['category_type'] = category_type
+    return doCurl("post","/ingest_job",params)
   end
 
 
   #
-  # Add a ingest job to the collection
+  # Get an ingest job from the collection
   #
-  #  @param description
-  #  @param category_type
+  #  @param job_id
   #  @return - the data from the api
   #
-  def postIngest_job( description, category_type)
+  def getIngest_job( job_id)
     params = Hash.new
-    params['description'] = description
-    params['category_type'] = category_type
-    return doCurl("post","/ingest_job",params)
+    params['job_id'] = job_id
+    return doCurl("get","/ingest_job",params)
   end
 
 
@@ -2865,30 +2888,30 @@ class CentralIndex
 
 
   #
-  # With a known entity id, a private object can be added.
+  # Allows a private object to be removed
   #
-  #  @param entity_id - The entity to associate the private object with
-  #  @param data - The data to store
+  #  @param private_object_id - The id of the private object to remove
   #  @return - the data from the api
   #
-  def putPrivate_object( entity_id, data)
+  def deletePrivate_object( private_object_id)
     params = Hash.new
-    params['entity_id'] = entity_id
-    params['data'] = data
-    return doCurl("put","/private_object",params)
+    params['private_object_id'] = private_object_id
+    return doCurl("delete","/private_object",params)
   end
 
 
   #
-  # Allows a private object to be removed
+  # With a known entity id, a private object can be added.
   #
-  #  @param private_object_id - The id of the private object to remove
+  #  @param entity_id - The entity to associate the private object with
+  #  @param data - The data to store
   #  @return - the data from the api
   #
-  def deletePrivate_object( private_object_id)
+  def putPrivate_object( entity_id, data)
     params = Hash.new
-    params['private_object_id'] = private_object_id
-    return doCurl("delete","/private_object",params)
+    params['entity_id'] = entity_id
+    params['data'] = data
+    return doCurl("put","/private_object",params)
   end
 
 
@@ -2945,10 +2968,10 @@ class CentralIndex
   #  @param destructive
   #  @return - the data from the api
   #
-  def getPtbModule( entity_id, module, destructive)
+  def getPtbModule( entity_id, __module, destructive)
     params = Hash.new
     params['entity_id'] = entity_id
-    params['module'] = module
+    params['module'] = __module
     params['destructive'] = destructive
     return doCurl("get","/ptb/module",params)
   end
@@ -2993,28 +3016,28 @@ class CentralIndex
 
 
   #
-  # Returns publisher that matches a given publisher id
+  # Delete a publisher with a specified publisher_id
   #
   #  @param publisher_id
   #  @return - the data from the api
   #
-  def getPublisher( publisher_id)
+  def deletePublisher( publisher_id)
     params = Hash.new
     params['publisher_id'] = publisher_id
-    return doCurl("get","/publisher",params)
+    return doCurl("delete","/publisher",params)
   end
 
 
   #
-  # Delete a publisher with a specified publisher_id
+  # Returns publisher that matches a given publisher id
   #
   #  @param publisher_id
   #  @return - the data from the api
   #
-  def deletePublisher( publisher_id)
+  def getPublisher( publisher_id)
     params = Hash.new
     params['publisher_id'] = publisher_id
-    return doCurl("delete","/publisher",params)
+    return doCurl("get","/publisher",params)
   end
 
 
@@ -3066,17 +3089,15 @@ class CentralIndex
 
 
   #
-  # Create a queue item
+  # With a known queue id, a queue item can be removed.
   #
-  #  @param queue_name
-  #  @param data
+  #  @param queue_id
   #  @return - the data from the api
   #
-  def putQueue( queue_name, data)
+  def deleteQueue( queue_id)
     params = Hash.new
-    params['queue_name'] = queue_name
-    params['data'] = data
-    return doCurl("put","/queue",params)
+    params['queue_id'] = queue_id
+    return doCurl("delete","/queue",params)
   end
 
 
@@ -3096,15 +3117,17 @@ class CentralIndex
 
 
   #
-  # With a known queue id, a queue item can be removed.
+  # Create a queue item
   #
-  #  @param queue_id
+  #  @param queue_name
+  #  @param data
   #  @return - the data from the api
   #
-  def deleteQueue( queue_id)
+  def putQueue( queue_name, data)
     params = Hash.new
-    params['queue_id'] = queue_id
-    return doCurl("delete","/queue",params)
+    params['queue_name'] = queue_name
+    params['data'] = data
+    return doCurl("put","/queue",params)
   end
 
 
@@ -3166,6 +3189,38 @@ class CentralIndex
   end
 
 
+  #
+  # Return a sales log by id
+  #
+  #  @param from_date
+  #  @param country
+  #  @param action_type
+  #  @return - the data from the api
+  #
+  def getSales_logBy_countryBy_date( from_date, country, action_type)
+    params = Hash.new
+    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
+
+
   #
   # Log a sale
   #
@@ -3183,7 +3238,7 @@ class CentralIndex
   #  @param expiry_date - The date the product expires
   #  @return - the data from the api
   #
-  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)
+  def postSales_logEntity( 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
@@ -3197,39 +3252,38 @@ class CentralIndex
     params['extra_tags'] = extra_tags
     params['extra_locations'] = extra_locations
     params['expiry_date'] = expiry_date
-    return doCurl("post","/sales_log",params)
+    return doCurl("post","/sales_log/entity",params)
   end
 
 
   #
-  # Return a sales log by id
+  # Add a Sales Log document for a syndication action
   #
-  #  @param from_date
-  #  @param country
   #  @param action_type
+  #  @param syndication_type
+  #  @param publisher_id
+  #  @param expiry_date
+  #  @param entity_id
+  #  @param group_id
+  #  @param seed_masheryid
+  #  @param supplier_masheryid
+  #  @param country
+  #  @param reseller_masheryid
   #  @return - the data from the api
   #
-  def getSales_logBy_countryBy_date( from_date, country, action_type)
+  def postSales_logSyndication( action_type, syndication_type, publisher_id, expiry_date, entity_id, group_id, seed_masheryid, supplier_masheryid, country, reseller_masheryid)
     params = Hash.new
-    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)
+    params['syndication_type'] = syndication_type
+    params['publisher_id'] = publisher_id
+    params['expiry_date'] = expiry_date
+    params['entity_id'] = entity_id
+    params['group_id'] = group_id
+    params['seed_masheryid'] = seed_masheryid
+    params['supplier_masheryid'] = supplier_masheryid
+    params['country'] = country
+    params['reseller_masheryid'] = reseller_masheryid
+    return doCurl("post","/sales_log/syndication",params)
   end
 
 
@@ -3297,6 +3351,58 @@ class CentralIndex
   end
 
 
+  #
+  # Add a Syndicate
+  #
+  #  @param syndication_type
+  #  @param publisher_id
+  #  @param expiry_date
+  #  @param entity_id
+  #  @param group_id
+  #  @param seed_masheryid
+  #  @param supplier_masheryid
+  #  @param country
+  #  @param reseller_masheryid
+  #  @return - the data from the api
+  #
+  def postSyndicationCreate( syndication_type, publisher_id, expiry_date, entity_id, group_id, seed_masheryid, supplier_masheryid, country, reseller_masheryid)
+    params = Hash.new
+    params['syndication_type'] = syndication_type
+    params['publisher_id'] = publisher_id
+    params['expiry_date'] = expiry_date
+    params['entity_id'] = entity_id
+    params['group_id'] = group_id
+    params['seed_masheryid'] = seed_masheryid
+    params['supplier_masheryid'] = supplier_masheryid
+    params['country'] = country
+    params['reseller_masheryid'] = reseller_masheryid
+    return doCurl("post","/syndication/create",params)
+  end
+
+
+  #
+  # When we get a syndication update make a record of it
+  #
+  #  @param entity_id - The entity to pull
+  #  @param publisher_id - The publisher this log entry refers to
+  #  @param action - The log type
+  #  @param success - If the syndication was successful
+  #  @param message - An optional message e.g. submitted to the syndication partner
+  #  @param syndicated_id - The entity as known to the publisher
+  #  @return - the data from the api
+  #
+  def postSyndication_log( entity_id, publisher_id, action, success, message, syndicated_id)
+    params = Hash.new
+    params['entity_id'] = entity_id
+    params['publisher_id'] = publisher_id
+    params['action'] = action
+    params['success'] = success
+    params['message'] = message
+    params['syndicated_id'] = syndicated_id
+    return doCurl("post","/syndication_log",params)
+  end
+
+
   #
   # Provides a tokenised URL to redirect a user so they can add an entity to Central Index
   #
@@ -3451,6 +3557,36 @@ class CentralIndex
   end
 
 
+  #
+  # The JaroWinklerDistance between two entities postal address objects
+  #
+  #  @param first_entity_id - The entity id of the first entity to be used in the postal address difference
+  #  @param second_entity_id - The entity id of the second entity to be used in the postal address difference
+  #  @return - the data from the api
+  #
+  def getToolsAddressdiff( first_entity_id, second_entity_id)
+    params = Hash.new
+    params['first_entity_id'] = first_entity_id
+    params['second_entity_id'] = second_entity_id
+    return doCurl("get","/tools/addressdiff",params)
+  end
+
+
+  #
+  # The JaroWinklerDistance between two entities postal address objects
+  #
+  #  @param first_entity_id - The entity id of the first entity to be used in the postal address difference
+  #  @param second_entity_id - The entity id of the second entity to be used in the postal address difference
+  #  @return - the data from the api
+  #
+  def getToolsAddressdiff2( first_entity_id, second_entity_id)
+    params = Hash.new
+    params['first_entity_id'] = first_entity_id
+    params['second_entity_id'] = second_entity_id
+    return doCurl("get","/tools/addressdiff2",params)
+  end
+
+
   #
   # Use this call to get information (in HTML or JSON) about the data structure of given entity object (e.g. a phone number or an address)
   #
@@ -3746,6 +3882,34 @@ class CentralIndex
   end
 
 
+  #
+  # Calls a number to make sure it is active
+  #
+  #  @param phone_number - The phone number to validate
+  #  @param country - The country code of the phone number to be validated
+  #  @return - the data from the api
+  #
+  def getToolsValidate_phone( phone_number, country)
+    params = Hash.new
+    params['phone_number'] = phone_number
+    params['country'] = country
+    return doCurl("get","/tools/validate_phone",params)
+  end
+
+
+  #
+  # Deleting a traction
+  #
+  #  @param traction_id
+  #  @return - the data from the api
+  #
+  def deleteTraction( traction_id)
+    params = Hash.new
+    params['traction_id'] = traction_id
+    return doCurl("delete","/traction",params)
+  end
+
+
   #
   # Update/Add a traction
   #
@@ -3785,19 +3949,6 @@ class CentralIndex
   end
 
 
-  #
-  # Deleting a traction
-  #
-  #  @param traction_id
-  #  @return - the data from the api
-  #
-  def deleteTraction( traction_id)
-    params = Hash.new
-    params['traction_id'] = traction_id
-    return doCurl("delete","/traction",params)
-  end
-
-
   #
   # Fetching a traction
   #
@@ -3822,19 +3973,6 @@ class CentralIndex
   end
 
 
-  #
-  # Given a transaction_id retrieve information on it
-  #
-  #  @param transaction_id
-  #  @return - the data from the api
-  #
-  def getTransaction( transaction_id)
-    params = Hash.new
-    params['transaction_id'] = transaction_id
-    return doCurl("get","/transaction",params)
-  end
-
-
   #
   # Create a new transaction
   #
@@ -3858,6 +3996,19 @@ class CentralIndex
   end
 
 
+  #
+  # Given a transaction_id retrieve information on it
+  #
+  #  @param transaction_id
+  #  @return - the data from the api
+  #
+  def getTransaction( transaction_id)
+    params = Hash.new
+    params['transaction_id'] = transaction_id
+    return doCurl("get","/transaction",params)
+  end
+
+
   #
   # Set a transactions status to authorised
   #

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 14
-  version: 0.0.14
+  - 15
+  version: 0.0.15
 platform: ruby
 authors: 
 - Glynn Bird