ws-3314: branding, url and key header updates

Adam Soos · Adam Soos · commit c48d815da1fc · 2024-10-24T16:04:01.000+02:00
diff --git a/source/rosette/api/Address.php b/source/rosette/api/Address.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Address represents a fielded address in Rosette API.
+ * Address represents a fielded address in Analytics API.
  *
  * @copyright 2020 Basis Technology Corporation.
  *
diff --git a/source/rosette/api/Api.php b/source/rosette/api/Api.php
@@ -3,7 +3,7 @@
 /**
  * Api.
  *
- * Primary class for interfacing with the Rosette API
+ * Primary class for interfacing with the Analytics API
  *
  * @copyright 2015-2023 Basis Technology Corporation.
  *
@@ -42,21 +42,21 @@ class Api
     private static $binding_version = '1.30.0';
 
     /**
-     * User key (required for Rosette API).
+     * User key (required for Analytics API).
      *
      * @var null|string
      */
     private $user_key;
 
     /**
-     * URL of the Rosette API (or test server).
+     * URL of the Analytics API (or test server).
      *
      * @var string
      */
     private $service_url;
 
     /**
-     * HTTP headers for Rosette API.
+     * HTTP headers for Analytics API.
      *
      * @var array
      */
@@ -136,11 +136,11 @@ class Api
      * @param string $user_key    An authentication string to be sent as user_key with
      *                            all requests.
      */
-    public function __construct($user_key, $service_url = 'https://api.rosette.com/rest/v1/')
+    public function __construct($user_key, $service_url = 'https://analytics.babelstreet.com/rest/v1/')
     {
         $this->user_key = $user_key;
 
-        $this->headers = array('X-RosetteAPI-Key' => $user_key,
+        $this->headers = array('X-BabelStreetAPI-Key' => $user_key,
             'Content-Type' => 'application/json',
             'Accept-Encoding' => 'gzip',
             'User-Agent' => $this->getUserAgent(),
@@ -275,7 +275,7 @@ public function setServiceUrl($url)
     }
 
     /**
-     * Setter for an additional query parameter to the Rosette API URL.
+     * Setter for an additional query parameter to the Analytics API URL.
      *
      * @param string $param_name (e.g. output)
      * @param string $param_value (e.g. rosette)
diff --git a/source/rosette/api/DocumentParameters.php b/source/rosette/api/DocumentParameters.php
@@ -3,7 +3,7 @@
 /**
  * class DocumentParameters.
  *
- * Parameter class for the standard Rosette API endpoints.  Does not include Name Translation
+ * Parameter class for the standard Analytics API endpoints.  Does not include Name Translation
  *
  * @copyright 2014-2015 Basis Technology Corporation.
  *
diff --git a/source/rosette/api/FieldedAddress.php b/source/rosette/api/FieldedAddress.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Address represents a fielded address in Rosette API.
+ * Address represents a fielded address in Analytics API.
  *
  * @copyright 2020 Basis Technology Corporation.
  *
diff --git a/source/rosette/api/IAddress.php b/source/rosette/api/IAddress.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Address represents an address in Rosette API.
+ * Address represents an address in Analytics API.
  *
  * @copyright 2020 Basis Technology Corporation.
  *
diff --git a/source/rosette/api/Include.php b/source/rosette/api/Include.php
@@ -2,7 +2,7 @@
 /**
  * Api.
  *
- * Primary class for interfacing with the Rosette API
+ * Primary class for interfacing with the Analytics API
  *
  * @copyright 2015-2016 Basis Technology Corporation.
  *
diff --git a/source/rosette/api/Name.php b/source/rosette/api/Name.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Name represents an entity name in Rosette API.
+ * Name represents an entity name in Analytics API.
  *
  * @copyright 2014-2015 Basis Technology Corporation.
  *
diff --git a/source/rosette/api/RosetteException.php b/source/rosette/api/RosetteException.php
@@ -24,7 +24,7 @@
 class RosetteException extends CustomException
 {
     /**
-     * The general error returned from Rosette API, indicating unrecognized format.
+     * The general error returned from Analytics API, indicating unrecognized format.
      *
      * @var int
      */
@@ -36,7 +36,7 @@ class RosetteException extends CustomException
      */
     public static $INVALID_DATATYPE = -3; // api error
     /**
-     * Internal error that throws if the Rosette API server version does not match the Api version.
+     * Internal error that throws if the Analytics API server version does not match the Api version.
      *
      * @var int
      */
diff --git a/source/rosette/api/RosetteParamsSetBase.php b/source/rosette/api/RosetteParamsSetBase.php
@@ -3,7 +3,7 @@
 /**
  * abstract class RosetteParamsSetBase.
  *
- * The base class for the parameter classes that are used for Rosette API operations.
+ * The base class for the parameter classes that are used for Analytics API operations.
  *
  * @copyright 2014-2015 Basis Technology Corporation.
  *
diff --git a/source/rosette/api/UnfieldedAddress.php b/source/rosette/api/UnfieldedAddress.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Address represents an unfielded address in Rosette API.
+ * Address represents an unfielded address in Analytics API.
  *
  * @copyright 2020 Basis Technology Corporation.
  *

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`	`3`	`/**`
`4`		`- * Address represents a fielded address in Rosette API.`
	`4`	`+ * Address represents a fielded address in Analytics API.`
`5`	`5`	`*`
`6`	`6`	`* @copyright 2020 Basis Technology Corporation.`
`7`	`7`	`*`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`/**`
`4`	`4`	`* Api.`
`5`	`5`	`*`
`6`		`- * Primary class for interfacing with the Rosette API`
	`6`	`+ * Primary class for interfacing with the Analytics API`
`7`	`7`	`*`
`8`	`8`	`* @copyright 2015-2023 Basis Technology Corporation.`
`9`	`9`	`*`
`@@ -42,21 +42,21 @@ class Api`
`42`	`42`	`private static $binding_version = '1.30.0';`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * User key (required for Rosette API).`
	`45`	`+ * User key (required for Analytics API).`
`46`	`46`	`*`
`47`	`47`	`* @var null\|string`
`48`	`48`	`*/`
`49`	`49`	`private $user_key;`
`50`	`50`
`51`	`51`	`/**`
`52`		`- * URL of the Rosette API (or test server).`
	`52`	`+ * URL of the Analytics API (or test server).`
`53`	`53`	`*`
`54`	`54`	`* @var string`
`55`	`55`	`*/`
`56`	`56`	`private $service_url;`
`57`	`57`
`58`	`58`	`/**`
`59`		`- * HTTP headers for Rosette API.`
	`59`	`+ * HTTP headers for Analytics API.`
`60`	`60`	`*`
`61`	`61`	`* @var array`
`62`	`62`	`*/`
`@@ -136,11 +136,11 @@ class Api`
`136`	`136`	`* @param string $user_key An authentication string to be sent as user_key with`
`137`	`137`	`* all requests.`
`138`	`138`	`*/`
`139`		`- public function __construct($user_key, $service_url = 'https://api.rosette.com/rest/v1/')`
	`139`	`+ public function __construct($user_key, $service_url = 'https://analytics.babelstreet.com/rest/v1/')`
`140`	`140`	`{`
`141`	`141`	`$this->user_key = $user_key;`
`142`	`142`
`143`		`- $this->headers = array('X-RosetteAPI-Key' => $user_key,`
	`143`	`+ $this->headers = array('X-BabelStreetAPI-Key' => $user_key,`
`144`	`144`	`'Content-Type' => 'application/json',`
`145`	`145`	`'Accept-Encoding' => 'gzip',`
`146`	`146`	`'User-Agent' => $this->getUserAgent(),`
`@@ -275,7 +275,7 @@ public function setServiceUrl($url)`
`275`	`275`	`}`
`276`	`276`
`277`	`277`	`/**`
`278`		`- * Setter for an additional query parameter to the Rosette API URL.`
	`278`	`+ * Setter for an additional query parameter to the Analytics API URL.`
`279`	`279`	`*`
`280`	`280`	`* @param string $param_name (e.g. output)`
`281`	`281`	`* @param string $param_value (e.g. rosette)`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`/**`
`4`	`4`	`* class DocumentParameters.`
`5`	`5`	`*`
`6`		`- * Parameter class for the standard Rosette API endpoints. Does not include Name Translation`
	`6`	`+ * Parameter class for the standard Analytics API endpoints. Does not include Name Translation`
`7`	`7`	`*`
`8`	`8`	`* @copyright 2014-2015 Basis Technology Corporation.`
`9`	`9`	`*`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`/**`
`3`	`3`	`* Api.`
`4`	`4`	`*`
`5`		`- * Primary class for interfacing with the Rosette API`
	`5`	`+ * Primary class for interfacing with the Analytics API`
`6`	`6`	`*`
`7`	`7`	`* @copyright 2015-2016 Basis Technology Corporation.`
`8`	`8`	`*`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`class RosetteException extends CustomException`
`25`	`25`	`{`
`26`	`26`	`/**`
`27`		`- * The general error returned from Rosette API, indicating unrecognized format.`
	`27`	`+ * The general error returned from Analytics API, indicating unrecognized format.`
`28`	`28`	`*`
`29`	`29`	`* @var int`
`30`	`30`	`*/`
`@@ -36,7 +36,7 @@ class RosetteException extends CustomException`
`36`	`36`	`*/`
`37`	`37`	`public static $INVALID_DATATYPE = -3; // api error`
`38`	`38`	`/**`
`39`		`- * Internal error that throws if the Rosette API server version does not match the Api version.`
	`39`	`+ * Internal error that throws if the Analytics API server version does not match the Api version.`
`40`	`40`	`*`
`41`	`41`	`* @var int`
`42`	`42`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`/**`
`4`	`4`	`* abstract class RosetteParamsSetBase.`
`5`	`5`	`*`
`6`		`- * The base class for the parameter classes that are used for Rosette API operations.`
	`6`	`+ * The base class for the parameter classes that are used for Analytics API operations.`
`7`	`7`	`*`
`8`	`8`	`* @copyright 2014-2015 Basis Technology Corporation.`
`9`	`9`	`*`