Merge pull request #164 from BrightLocal/task/PS-2929

PS-2929 Remove location-based fields from Add/Update Report endpoints

source/includes/_lsrc.md

@@ -15,7 +15,6 @@ use BrightLocal\Api;
 $api = new Api('<YOUR_API_KEY>', '<YOUR_API_SECRET>');
 $response = $api->post('/v2/lsrc/add', [
     'location-id'       => 1,
-    'name'              => 'Le Bernardin',
     'schedule'          => 'Adhoc',
     'search-terms'      => 'Restaurant\nfood+nyc\ndelivery+midtown+manhattan',
     'website-addresses' => '["le-bernardin.com", "le-bernardin2.com"]',
@@ -30,7 +29,6 @@ curl -X POST \
  -d 'sig=<INSERT_API_SIG>' \
  -d 'expires=<INSERT_API_EXPIRES>' \
  -d 'location-id=1' \
- -d 'name=Le Bernardin' \
  -d 'schedule=Adhoc' \
  -d $'search-terms=Restaurant\nfood+nyc\ndelivery+midtown+manhattan' \ 
  -d 'website-addresses=["le-bernardin.com","le-bernardin2.com"]' \
@@ -43,7 +41,6 @@ Api api = new Api("<INSERT_API_KEY>", "<INSERT_API_SECRET>");
 Parameters parameters = new Parameters
     {
         { "location-id", 1},
-        { "name", "Le Bernardin" },
         { "schedule", "Adhoc" },
         { "search-terms", "Restaurant\nfood+nyc\ndelivery+midtown+manhattan" },
         { "website-addresses", new List<string> { "le-bernardin.com", "le-bernardin.ca" } },
@@ -77,12 +74,12 @@ Parameter | Notes
 api-key | <span class="label label-required">Required</span>	
 sig | <span class="label label-required">Required</span> [See above for how to generate signature and expires values.](#authentication)
 expires | <span class="label label-required">Required</span> [See above for how to generate signature and expires values.](#authentication)
-name | <span class="label label-required">Required</span>	
+name | <span class="label label-deprecated">Deprecated</span>	
 schedule | Adhoc, Weekly or Monthly - defaults to Adhoc
 day-of-week | Relevant to Weekly schedule only. Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday. Defaults to Tuesday.
 day-of-month | One of 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, -1 (last day of month). Defaults to 1
 location-id |	<span class="label label-required">Required</span>	
-white-label-profile-id | (branding-profile-id is also supported but deprecated)
+white-label-profile-id | <span class="label label-deprecated">Deprecated</span>	(branding-profile-id is also no longer supported)
 tags | Comma separated list of tags
 search-terms | <span class="label label-required">Required</span> Newline (\n) separated list of search terms.
 website-addresses	| Supply one or more website addresses (max 10) as a JSON string. For example, [“test.com”,“test2.com”].
@@ -99,7 +96,7 @@ search-engines | Comma separated list of search engines. Options are google, goo
 include-local-directory-results	| Yes or No. Defaults to Yes.
 notify | Yes or No. Defaults to No.
 email-addresses	| Newline (\n) separated list of email addresses
-is-public | Publish reports on a white label URL. Yes or No. Defaults to No.
+is-public | <span class="label label-deprecated">Deprecated</span> (uses location setting) Publish reports on a white label URL. Yes or No. Defaults to No.
 run-time | One of '00:00:00', '03:00:00', '06:00:00', '09:00:00', '12:00:00', '15:00:00', '18:00:00', '21:00:00'
 time-zone | One of 'Pacific/Honolulu', 'America/Los_Angeles', 'America/Anchorage', 'US/Pacific', 'America/Phoenix', 'America/Denver', 'America/Boise', 'US/Central', 'Canada/Saskatchewan', 'America/North_Dakota', 'America/Chicago', 'America/New_York', 'America/Kentucky', 'America/Indiana', 'America/Detroit', 'US/Eastern', 'Canada/Atlantic', 'Canada/Newfoundland', 'Europe/London', 'Europe/Dublin', 'Australia/Perth', 'Australia/Darwin', 'Australia/Brisbane', 'Australia/Sydney', 'Pacific/Auckland', 'US/Mountain', 'America/North_Dakota/Center', 'America/Kentucky/Louisville', 'America/Indiana/Indianapolis'
 
@@ -119,7 +116,6 @@ $api = new Api('<YOUR_API_KEY>', '<YOUR_API_SECRET>');
 $response = $api->post('/v2/lsrc/update', [
     'location-id'       => 1,
     'campaign-id'       => 9907,
-    'name'              => 'Le Bernardin',
     'schedule'          => 'Adhoc',
     'search-terms'      => 'Restaurant\nfood+nyc\ndelivery+midtown+manhattan',
     'website-addresses' => '["le-bernardin.com", "le-bernardin2.com"]',
@@ -135,7 +131,6 @@ curl -X POST \
  -d 'expires=<INSERT_API_EXPIRES>' \
  -d 'location-id=1' \
  -d 'campaign-id=9907' \
- -d 'name=Le Bernardin' \
  -d 'schedule=Adhoc' \
  -d $'search-terms=Restaurant\nfood+nyc\ndelivery+midtown+manhattan' \ 
  -d 'website-addresses=["le-bernardin.com","le-bernardin2.com"]' \
@@ -149,7 +144,6 @@ Parameters parameters = new Parameters
 {
     { "location-id", 1 },
     { "campaign-id", 9907 },
-    { "name", "Le Bernardin" },
     { "schedule", "Adhoc" },
     { "search-terms", "Restaurant\nfood+nyc\ndelivery+midtown+manhattan" },
     { "website-addresses", new List<string> { "le-bernardin.com", "le-bernardin.ca" } },
@@ -185,12 +179,12 @@ api-key | <span class="label label-required">Required</span>
 sig | <span class="label label-required">Required</span> [See above for how to generate signature and expires values.](#authentication)
 expires | <span class="label label-required">Required</span> [See above for how to generate signature and expires values.](#authentication)
 campaign-id | <span class="label label-required">Required</span>	
-name |	
+name | <span class="label label-deprecated">Deprecated</span>	
 schedule | Adhoc, Weekly or Monthly
 day-of-week | Relevant to Weekly schedule only. Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday.
 day-of-month | One of 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, -1 (last day of month).
 location-id |	<span class="label label-required">Required</span>	
-white-label-profile-id | (branding-profile-id is also supported but deprecated)
+white-label-profile-id | <span class="label label-deprecated">Deprecated</span> (branding-profile-id is also no longer supported)
 tags | Comma separated list of tags
 search-terms | Newline (\n) separated list of search terms
 website-addresses	| Supply one or more website addresses (max 10) as a JSON string. For example, [“test.com”,“test2.com”].
@@ -207,7 +201,7 @@ search-engines | Comma separated list of search engines. Options are google, goo
 include-local-directory-results	| Yes or No
 notify | Yes or No
 email-addresses | Newline (\n) separated list of email addresses
-is-public | Publish reports on a white label URL. Yes or No.
+is-public | <span class="label label-deprecated">Deprecated</span> (uses location setting) Publish reports on a white label URL. Yes or No.
 run-time | One of '00:00:00', '03:00:00', '06:00:00', '09:00:00', '12:00:00', '15:00:00', '18:00:00', '21:00:00'
 time-zone | One of '(UTC-10:00) Hawaii','(UTC-08:00) Pacific Time (US & Canada)','(UTC-07:00) Mountain Time (US & Canada)','(UTC-06:00) Central Time (US & Canada)','(UTC-05:00) Eastern Time (US & Canada)','(UTC-04:00) Atlantic Time (Canada)','(UTC-03:30) Newfoundland','(UTC) Dublin, Edinburgh, London','(UTC+08:00) Perth','(UTC+09:30) Adelaide, Darwin','(UTC+10:00) Brisbane, Melbourne, Sydney','(UTC+12:00) Auckland, Wellington'
 

source/stylesheets/screen.css.scss

@@ -602,6 +602,11 @@ h2 .label {
 .label-required {
   background: #f50;
 }
+
+.label-deprecated {
+  background: #888;
+  font-style: italic;
+}
 .label-info {
   background: #ccc;
 }