Merge pull request #184 from maxmind/greg/release

Release 3.2.0-beta.2

CHANGELOG.md

@@ -1,12 +1,13 @@
 CHANGELOG
 =========
 
-3.2.0
-----------------
+3.2.0-beta.2 (2024-11-15)
+-------------------------
 
 * The minFraud Factors subscores have been deprecated. They will be removed
   in March 2025. Please see [our release notes](https://dev.maxmind.com/minfraud/release-notes/2024/#deprecation-of-risk-factor-scoressubscores)
   for more information.
+* The type hints in the PHPDocs have been improved.
 
 3.2.0-beta.1 (2024-09-06)
 -------------------------

composer.json

@@ -19,8 +19,7 @@
   "require": {
     "php": ">=8.1",
     "ext-json": "*",
-    "geoip2/geoip2": "^v3.0.0",
-    "maxmind/web-service-common": "^0.9.0"
+    "geoip2/geoip2": "^v3.1.0"
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "3.*",

dev-bin/release.sh

@@ -46,10 +46,10 @@ php composer.phar update --no-dev
 
 perl -pi -e "s/(?<=const VERSION = ').+?(?=';)/$tag/g" src/MinFraud/ServiceClient.php
 
-box_phar_hash='c24c400c424a68041d7af146c71943bf1acc0c5abafa45297c503b832b9c6b16  box.phar'
+box_phar_hash='8d12a7d69a5003a80bd603ea95a8f3dcea30b9a2ad84cd7cb15b8193929def9e  box.phar'
 
 if ! echo "$box_phar_hash" | sha256sum -c; then
-    wget -O box.phar "https://github.com/box-project/box/releases/download/4.5.1/box.phar"
+    wget -O box.phar "https://github.com/box-project/box/releases/download/4.6.1/box.phar"
 fi
 
 echo "$box_phar_hash" | sha256sum -c
@@ -94,10 +94,10 @@ if [ -n "$(git status --porcelain)" ]; then
 fi
 
 # Using Composer is possible, but they don't recommend it.
-phpdocumentor_phar_hash='bad7e4b8c99e73391bb3183a127593ecd1cd66ae42b4a33efe495d193e257f04  phpDocumentor.phar'
+phpdocumentor_phar_hash='9760ac280a10041928a8743354f68692c22f14cd5d05135dfc15e11d3b3c25ea  phpDocumentor.phar'
 
 if ! echo "$phpdocumentor_phar_hash" | sha256sum -c; then
-    wget -O phpDocumentor.phar https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.4.3/phpDocumentor.phar
+    wget -O phpDocumentor.phar https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.5.3/phpDocumentor.phar
 fi
 
 echo "$phpdocumentor_phar_hash" | sha256sum -c

phpstan.neon

@@ -3,4 +3,3 @@ parameters:
     paths:
         - src
         - tests
-    checkMissingIterableValueType: false

src/MinFraud/Model/Address.php

@@ -41,6 +41,9 @@ abstract class Address implements \JsonSerializable
      */
     public readonly ?float $longitude;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         $this->distanceToIpLocation = $response['distance_to_ip_location'] ?? null;
@@ -50,6 +53,9 @@ public function __construct(?array $response)
         $this->longitude = $response['longitude'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/CreditCard.php

@@ -63,6 +63,9 @@ class CreditCard implements \JsonSerializable
      */
     public readonly ?string $type;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         $this->issuer = new Issuer($response['issuer'] ?? []);
@@ -77,6 +80,9 @@ public function __construct(?array $response)
         $this->type = $response['type'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/Device.php

@@ -42,6 +42,9 @@ class Device implements \JsonSerializable
      */
     public readonly ?string $localTime;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         $this->confidence = $response['confidence'] ?? null;
@@ -50,6 +53,9 @@ public function __construct(?array $response)
         $this->localTime = $response['local_time'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/Disposition.php

@@ -34,13 +34,19 @@ class Disposition implements \JsonSerializable
      */
     public readonly ?string $ruleLabel;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         $this->action = $response['action'] ?? null;
         $this->reason = $response['reason'] ?? null;
         $this->ruleLabel = $response['rule_label'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/Email.php

@@ -42,6 +42,9 @@ class Email implements \JsonSerializable
      */
     public readonly ?bool $isHighRisk;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         $this->domain = new EmailDomain($response['domain'] ?? null);
@@ -51,6 +54,9 @@ public function __construct(?array $response)
         $this->isHighRisk = $response['is_high_risk'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/EmailDomain.php

@@ -16,11 +16,17 @@ class EmailDomain implements \JsonSerializable
      */
     public readonly ?string $firstSeen;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         $this->firstSeen = $response['first_seen'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/Factors.php

@@ -28,6 +28,10 @@ class Factors extends Insights
      */
     public readonly Subscores $subscores;
 
+    /**
+     * @param array<string, mixed> $response
+     * @param list<string>         $locales
+     */
     public function __construct(array $response, array $locales = ['en'])
     {
         parent::__construct($response, $locales);
@@ -44,6 +48,9 @@ public function __construct(array $response, array $locales = ['en'])
             = new Subscores($response['subscores'] ?? []);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = parent::jsonSerialize();

src/MinFraud/Model/GeoIp2Location.php

@@ -19,13 +19,19 @@ class GeoIp2Location extends Location
      */
     public readonly ?string $localTime;
 
+    /**
+     * @param array<string, mixed> $record
+     */
     public function __construct(array $record)
     {
         parent::__construct($record);
 
         $this->localTime = $record['local_time'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = parent::jsonSerialize();

src/MinFraud/Model/Insights.php

@@ -94,14 +94,18 @@ class Insights implements \JsonSerializable
     public readonly Phone $shippingPhone;
 
     /**
-     * @var array This array contains \MaxMind\MinFraud\Model\Warning objects
-     *            detailing issues with the request that was sent, such as
-     *            invalid or unknown inputs. It is highly recommended that
-     *            you check this array for issues when integrating the web
-     *            service.
+     * @var array<Warning> This array contains \MaxMind\MinFraud\Model\Warning objects
+     *                     detailing issues with the request that was sent, such as
+     *                     invalid or unknown inputs. It is highly recommended that
+     *                     you check this array for issues when integrating the web
+     *                     service.
      */
     public readonly array $warnings;
 
+    /**
+     * @param array<string, mixed> $response
+     * @param list<string>         $locales
+     */
     public function __construct(array $response, array $locales = ['en'])
     {
         $this->disposition
@@ -129,6 +133,9 @@ public function __construct(array $response, array $locales = ['en'])
         $this->shippingPhone = new Phone($response['shipping_phone'] ?? []);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/IpAddress.php

@@ -87,13 +87,13 @@ class IpAddress implements \JsonSerializable
     public readonly array $riskReasons;
 
     /**
-     * @var array An array of \GeoIp2\Record\Subdivision objects representing
-     *            the country subdivisions for the requested IP address. The
-     *            number and type of subdivisions varies by country, but a
-     *            subdivision is typically a state, province, county, etc.
-     *            Subdivisions are ordered from most general (largest) to most
-     *            specific (smallest). If the response did not contain any
-     *            subdivisions, this method returns an empty array.
+     * @var array<Subdivision> An array of \GeoIp2\Record\Subdivision objects representing
+     *                         the country subdivisions for the requested IP address. The
+     *                         number and type of subdivisions varies by country, but a
+     *                         subdivision is typically a state, province, county, etc.
+     *                         Subdivisions are ordered from most general (largest) to most
+     *                         specific (smallest). If the response did not contain any
+     *                         subdivisions, this method returns an empty array.
      */
     public readonly array $subdivisions;
 
@@ -103,6 +103,10 @@ class IpAddress implements \JsonSerializable
      */
     public readonly Traits $traits;
 
+    /**
+     * @param array<string, mixed>|null $response
+     * @param list<string>              $locales
+     */
     public function __construct(?array $response, array $locales = ['en'])
     {
         if ($response === null) {
@@ -132,6 +136,9 @@ public function __construct(?array $response, array $locales = ['en'])
         $this->riskReasons = $riskReasons;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): ?array
     {
         $js = [];

src/MinFraud/Model/IpRiskReason.php

@@ -41,12 +41,18 @@ class IpRiskReason implements \JsonSerializable
      */
     public readonly ?string $reason;
 
+    /**
+     * @param array<string, mixed> $response
+     */
     public function __construct(array $response)
     {
         $this->code = $response['code'];
         $this->reason = $response['reason'];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/Issuer.php

@@ -38,6 +38,9 @@ class Issuer implements \JsonSerializable
      */
     public readonly ?bool $matchesProvidedPhoneNumber;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         $this->name = $response['name'] ?? null;
@@ -48,6 +51,9 @@ public function __construct(?array $response)
             = $response['matches_provided_phone_number'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/Phone.php

@@ -38,6 +38,9 @@ class Phone implements \JsonSerializable
      */
     public readonly ?string $numberType;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         $this->country = $response['country'] ?? null;
@@ -46,6 +49,9 @@ public function __construct(?array $response)
         $this->numberType = $response['number_type'] ?? null;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/Reason.php

@@ -66,12 +66,18 @@ class Reason implements \JsonSerializable
      */
     public readonly string $reason;
 
+    /**
+     * @param array<string, mixed> $response
+     */
     public function __construct(array $response)
     {
         $this->code = $response['code'];
         $this->reason = $response['reason'];
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): array
     {
         $js = [];

src/MinFraud/Model/RiskScoreReason.php

@@ -23,6 +23,9 @@ class RiskScoreReason implements \JsonSerializable
      */
     public readonly array $reasons;
 
+    /**
+     * @param array<string, mixed>|null $response
+     */
     public function __construct(?array $response)
     {
         if ($response === null) {
@@ -40,6 +43,9 @@ public function __construct(?array $response)
         $this->reasons = $reasons;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function jsonSerialize(): ?array
     {
         $js = [];