Feature/new request handling logic inter 767

contributing.md

@@ -5,8 +5,8 @@
 Most files in the project are autogenerated by [swagger-codegen](https://swagger.io/tools/swagger-codegen/) for php.
 
 - [template](./template) - folder contains redefined templates of `swagger-codegen`. Original templates you can find in [swagger-codegen repo](https://github.com/swagger-api/swagger-codegen/tree/751e59df060b1c3ecf54921e104f2086dfa9f820/modules/swagger-codegen/src/main/resources/php).
-- [docs](./docs) - generated documentation for models and [API Client](./docs/Api/FingerprintApi.md).
-- [src](./src) - API Client code is generated automatically.
+- [docs](./docs) - generated documentation for models and [API Client](docs/Api/FingerprintApi.md).
+- [src](./src) - API Client code and generated models.
 
 ## Code generation
 

docs/Api/FingerprintApi.md

@@ -30,17 +30,17 @@ use GuzzleHttp\Client;
 // Create new Configuration instance with defaultValues, added our API Secret and our Region
 $config = Configuration::getDefaultConfiguration(FPJS_API_SECRET, Configuration::REGION_EUROPE);
 $client = new FingerprintApi(
-    new Client(),
-    $config
+new Client(),
+$config
 );
 
 $request_id = "request_id_example"; // string | The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each analysis request.
 
 try {
-    $result = $client->getEvent($request_id);
+$result = $client->getEvent($request_id);
     echo "<pre>" . $response->__toString() . "</pre>";
 } catch (Exception $e) {
-    echo 'Exception when calling FingerprintApi->getEvent: ', $e->getMessage(), PHP_EOL;
+echo 'Exception when calling FingerprintApi->getEvent: ', $e->getMessage(), PHP_EOL;
 }
 ?>
 ```
@@ -89,8 +89,8 @@ use GuzzleHttp\Client;
 // Create new Configuration instance with defaultValues, added our API Secret and our Region
 $config = Configuration::getDefaultConfiguration(FPJS_API_SECRET, Configuration::REGION_EUROPE);
 $client = new FingerprintApi(
-    new Client(),
-    $config
+new Client(),
+$config
 );
 
 $visitor_id = "visitor_id_example"; // string | Unique identifier of the visitor issued by Fingerprint Pro.
@@ -101,10 +101,10 @@ $pagination_key = "pagination_key_example"; // string | Use `paginationKey` to g
 $before = 789; // int | ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results.
 
 try {
-    $result = $client->getVisits($visitor_id, $request_id, $linked_id, $limit, $pagination_key, $before);
+$result = $client->getVisits($visitor_id, $request_id, $linked_id, $limit, $pagination_key, $before);
     echo "<pre>" . $response->__toString() . "</pre>";
 } catch (Exception $e) {
-    echo 'Exception when calling FingerprintApi->getVisits: ', $e->getMessage(), PHP_EOL;
+echo 'Exception when calling FingerprintApi->getVisits: ', $e->getMessage(), PHP_EOL;
 }
 ?>
 ```

run_checks.php

@@ -45,22 +45,32 @@
 
 try {
     $result = $client->getVisits($visitor_id);
-    fwrite(STDOUT, sprintf("Got visits: %s \n", $result));
+    $rawResponseDecoded = json_decode($result->getRawResponse(), true);
+    if ($rawResponseDecoded['visitorId'] !== $visitor_id) {
+        fwrite(STDERR, sprintf("Raw response for getVisits not working"));
+        exit(1);
+    }
+    fwrite(STDOUT, sprintf("Got visits: %s \n", $result->getRawResponse()));
 } catch (Exception $e) {
     fwrite(STDERR, sprintf("Exception when calling FingerprintApi->getVisits: %s\n", $e->getMessage()));
     exit(1);
 }
 
 try {
     $result = $client->getEvent($request_id);
-    fwrite(STDOUT, sprintf("Got event: %s \n", $result));
+    $rawResponseDecoded = json_decode($result->getRawResponse(), true);
+    if ($rawResponseDecoded['products']['identification']['data']['requestId'] !== $request_id) {
+        fwrite(STDERR, sprintf("Raw response for getEvent not working"));
+        exit(1);
+    }
+    fwrite(STDOUT, sprintf("\n\nGot event: %s \n", $result->getRawResponse()));
 } catch (Exception $e) {
-    fwrite(STDERR, sprintf("Exception when calling FingerprintApi->getVisits: %s\n", $e->getMessage()));
+    fwrite(STDERR, sprintf("\n\nException when calling FingerprintApi->getVisits: %s\n", $e->getMessage()));
     exit(1);
 }
 
 // Enable the deprecated ArrayAccess return type warning again if needed
 error_reporting(error_reporting() | E_DEPRECATED);
 
-fwrite(STDOUT, "Checks passed\n");
+fwrite(STDOUT, "\n\nChecks passed\n");
 exit(0);

scripts/generate.sh

@@ -67,3 +67,16 @@ mv -f src/README.md ./README.md
 mv -f src/composer.json composer.json
 find ./docs -type f ! -name "DecryptionKey.md" ! -name "Sealed.md" -exec rm {} +
 mv -f src/docs/* ./docs
+
+declare -a modelsWithRawResponse=("./src/Model/EventResponse.php" "./src/Model/Response.php")
+
+for model in "${modelsWithRawResponse[@]}"; do
+  # enable WithRawResponse trait for the model
+  (
+    if [ "$platform" = "Darwin" ]; then
+      sed -i '' 's/\/\/ use \\/use \\/' $model
+    else
+      sed -i 's/\/\/ use \\/use \\/' $model
+    fi
+  )
+done

src/Api/FingerprintApi.php

@@ -48,20 +48,9 @@
  */
 class FingerprintApi
 {
-    /**
-     * @var ClientInterface
-     */
-    protected $client;
-
-    /**
-     * @var Configuration
-     */
-    protected $config;
-
-    /**
-     * @var HeaderSelector
-     */
-    protected $headerSelector;
+    protected ClientInterface $client;
+    protected Configuration $config;
+    protected HeaderSelector $headerSelector;
 
     protected $integration_info = 'fingerprint-pro-server-php-sdk/4.1.0';
 
@@ -159,36 +148,45 @@ public function getEventWithHttpInfo($request_id)
                 }
             }
 
+            $serialized = ObjectSerializer::deserialize($content, $returnType, []);
+            $serialized->setRawResponse($responseBody);
+
             return [
-                ObjectSerializer::deserialize($content, $returnType, []),
+                $serialized,
                 $response->getStatusCode(),
                 $response->getHeaders()
             ];
 
         } catch (ApiException $e) {
             switch ($e->getCode()) {
                 case 200:
+                    $responseBody = $e->getResponseBody();
                     $data = ObjectSerializer::deserialize(
-                        $e->getResponseBody(),
+                        $responseBody,
                         '\Fingerprint\ServerAPI\Model\EventResponse',
                         $e->getResponseHeaders()
                     );
+                    $data->setRawResponse($responseBody);
                     $e->setResponseObject($data);
                     break;
                 case 403:
+                    $responseBody = $e->getResponseBody();
                     $data = ObjectSerializer::deserialize(
-                        $e->getResponseBody(),
+                        $responseBody,
                         '\Fingerprint\ServerAPI\Model\ErrorEvent403Response',
                         $e->getResponseHeaders()
                     );
+                    $data->setRawResponse($responseBody);
                     $e->setResponseObject($data);
                     break;
                 case 404:
+                    $responseBody = $e->getResponseBody();
                     $data = ObjectSerializer::deserialize(
-                        $e->getResponseBody(),
+                        $responseBody,
                         '\Fingerprint\ServerAPI\Model\ErrorEvent404Response',
                         $e->getResponseHeaders()
                     );
+                    $data->setRawResponse($responseBody);
                     $e->setResponseObject($data);
                     break;
             }
@@ -245,8 +243,11 @@ function ($response) use ($returnType) {
                         }
                     }
 
+                    $serialized = ObjectSerializer::deserialize($content, $returnType, []);
+                    $serialized->setRawResponse($responseBody);
+
                     return [
-                        ObjectSerializer::deserialize($content, $returnType, []),
+                        $serialized,
                         $response->getStatusCode(),
                         $response->getHeaders()
                     ];
@@ -457,36 +458,45 @@ public function getVisitsWithHttpInfo($visitor_id, $request_id = null, $linked_i
                 }
             }
 
+            $serialized = ObjectSerializer::deserialize($content, $returnType, []);
+            $serialized->setRawResponse($responseBody);
+
             return [
-                ObjectSerializer::deserialize($content, $returnType, []),
+                $serialized,
                 $response->getStatusCode(),
                 $response->getHeaders()
             ];
 
         } catch (ApiException $e) {
             switch ($e->getCode()) {
                 case 200:
+                    $responseBody = $e->getResponseBody();
                     $data = ObjectSerializer::deserialize(
-                        $e->getResponseBody(),
+                        $responseBody,
                         '\Fingerprint\ServerAPI\Model\Response',
                         $e->getResponseHeaders()
                     );
+                    $data->setRawResponse($responseBody);
                     $e->setResponseObject($data);
                     break;
                 case 403:
+                    $responseBody = $e->getResponseBody();
                     $data = ObjectSerializer::deserialize(
-                        $e->getResponseBody(),
+                        $responseBody,
                         '\Fingerprint\ServerAPI\Model\ErrorVisits403',
                         $e->getResponseHeaders()
                     );
+                    $data->setRawResponse($responseBody);
                     $e->setResponseObject($data);
                     break;
                 case 429:
+                    $responseBody = $e->getResponseBody();
                     $data = ObjectSerializer::deserialize(
-                        $e->getResponseBody(),
+                        $responseBody,
                         '\Fingerprint\ServerAPI\Model\ManyRequestsResponse',
                         $e->getResponseHeaders()
                     );
+                    $data->setRawResponse($responseBody);
                     $e->setResponseObject($data);
                     break;
             }
@@ -553,8 +563,11 @@ function ($response) use ($returnType) {
                         }
                     }
 
+                    $serialized = ObjectSerializer::deserialize($content, $returnType, []);
+                    $serialized->setRawResponse($responseBody);
+
                     return [
-                        ObjectSerializer::deserialize($content, $returnType, []),
+                        $serialized,
                         $response->getStatusCode(),
                         $response->getHeaders()
                     ];

src/Model/ASN.php

@@ -41,6 +41,7 @@
  */
 class ASN implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/BotdDetectionResult.php

@@ -42,6 +42,7 @@
  */
 class BotdDetectionResult implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/BotdResult.php

@@ -42,6 +42,7 @@
  */
 class BotdResult implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/BrowserDetails.php

@@ -41,6 +41,7 @@
  */
 class BrowserDetails implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/ClonedAppResult.php

@@ -41,6 +41,7 @@
  */
 class ClonedAppResult implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/Confidence.php

@@ -41,6 +41,7 @@
  */
 class Confidence implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/DataCenter.php

@@ -41,6 +41,7 @@
  */
 class DataCenter implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/DeprecatedIPLocation.php

@@ -42,6 +42,7 @@
  */
 class DeprecatedIPLocation implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/DeprecatedIPLocationCity.php

@@ -41,6 +41,7 @@
  */
 class DeprecatedIPLocationCity implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/EmulatorResult.php

@@ -41,6 +41,7 @@
  */
 class EmulatorResult implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/ErrorEvent403Response.php

@@ -41,6 +41,7 @@
  */
 class ErrorEvent403Response implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/ErrorEvent403ResponseError.php

@@ -41,6 +41,7 @@
  */
 class ErrorEvent403ResponseError implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/ErrorEvent404Response.php

@@ -41,6 +41,7 @@
  */
 class ErrorEvent404Response implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/ErrorEvent404ResponseError.php

@@ -41,6 +41,7 @@
  */
 class ErrorEvent404ResponseError implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/ErrorVisits403.php

@@ -41,6 +41,7 @@
  */
 class ErrorVisits403 implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/EventResponse.php

@@ -42,6 +42,7 @@
  */
 class EventResponse implements ModelInterface, ArrayAccess
 {
+    use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**

src/Model/FactoryResetResult.php

@@ -41,6 +41,7 @@
  */
 class FactoryResetResult implements ModelInterface, ArrayAccess
 {
+    // use \Fingerprint\ServerAPI\Traits\WithRawResponse;
     const DISCRIMINATOR = null;
 
     /**