Merge pull request #356 from EasyPost/breaking_changes

Breaking changes

Author: Justintime50

.github/workflows/ci.yml

@@ -11,8 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: set up PHP
-        uses: shivammathur/setup-php@v2
+      - uses: shivammathur/setup-php@v2
         with:
           php-version: '8.3'
       - name: install dependencies
@@ -23,11 +22,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        phpversion: ['8.0', '8.1', '8.2', '8.3']
+        # TODO: Add 8.4 when VCR releases a version compatible with it
+        phpversion: ['8.1', '8.2', '8.3']
     steps:
       - uses: actions/checkout@v4
-      - name: set up PHP
-        uses: shivammathur/setup-php@v2
+      - uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.phpversion }}
           coverage: xdebug
@@ -53,10 +52,8 @@ jobs:
     if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-      - name: Set up PHP
-        uses: shivammathur/setup-php@v2
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
         with:
           php-version: '8.3'
       - name: Install Dependencies

CHANGELOG.md

@@ -2,15 +2,19 @@
 
 ## Next Release
 
+- Drops support for PHP 8.0
 - Adds `custom_headers` property to webhook model
 - Corrects wrapping payload for update webhook endpoint
+- Corrects various type hints throughout project
 - Fixes error handling
   - Corrects the type of `errors` property on an `ApiException` to allow for the alternative format
   - Fixes a bug where you could not `prettyPrint` an error if it used the alternative format
   - Corrects the `param` references to `property` references on all error models
   - Adds new `AddressVerificationFieldError` for the `errors` property on a `Verification` model
   - Adds missing `suggestion` property to `FieldError`
-- Removes the deprecated `create_list` tracker endpoint function as it is no longer available via API
+- Removes deprecated `createList` tracker endpoint function as it is no longer available via API
+- Removes deprecated `user.allApiKeys` and `user.apiKeys`, use `apiKey.all` and `apiKey.retrieveApiKeysForUser` respectively
+- Bump deps
 
 ## v7.4.2 (2024-08-16)
 

composer.json

@@ -19,18 +19,18 @@
   ],
   "require": {
     "ext-json": "*",
-    "php": ">=8.0",
-    "guzzlehttp/guzzle": "^7.5"
+    "php": ">=8.1",
+    "guzzlehttp/guzzle": "^7.9"
   },
   "require-dev": {
-    "allejo/php-vcr-sanitizer": "^1.0.9",
-    "php-coveralls/php-coveralls": "^2.5",
-    "php-vcr/php-vcr": "^1.7",
-    "phpunit/phpunit": "^9",
-    "squizlabs/php_codesniffer": "^3.7",
+    "allejo/php-vcr-sanitizer": "^1.1",
+    "php-coveralls/php-coveralls": "^2.7",
+    "php-vcr/php-vcr": "^1.8",
+    "phpunit/phpunit": "^10",
+    "squizlabs/php_codesniffer": "^3.11",
     "roave/security-advisories": "dev-latest",
     "rregeer/phpunit-coverage-check": "^0.3.1",
-    "phpstan/phpstan": "^1.11"
+    "phpstan/phpstan": "^2.1"
   },
   "scripts": {
     "coverage": "XDEBUG_MODE=coverage ./bin/phpunit --coverage-html clover.html --coverage-clover build/logs/clover.xml && ./bin/coverage-check build/logs/clover.xml 85 --only-percentage",

lib/EasyPost/Batch.php

@@ -10,7 +10,7 @@
  * @property string $mode
  * @property string $state
  * @property int $num_shipments
- * @property array $shipments
+ * @property Shipment[] $shipments
  * @property object $status
  * @property string $label_url
  * @property ScanForm $scan_form

lib/EasyPost/EasyPostObject.php

@@ -241,7 +241,7 @@ public function next(): void
     public function valid(): bool
     {
         $key = key($this->_values);
-        return ($key !== null && $key !== false);
+        return $key !== null;
     }
 
     /**

lib/EasyPost/Event.php

@@ -11,8 +11,8 @@
  * @property object $previous_attributes
  * @property object $result
  * @property string $status
- * @property array $pending_urls
- * @property array $completed_urls
+ * @property array<string> $pending_urls
+ * @property array<string> $completed_urls
  * @property string $created_at
  * @property string $updated_at
  */

lib/EasyPost/Exception/Api/ApiException.php

@@ -9,7 +9,7 @@
 /**
  * @package EasyPost
  * @property string|null $code
- * @property array<int, FieldError|array>|null $errors
+ * @property array<FieldError|array<string>>|null $errors
  * @property string $message
  * @property string|null $httpBody
  * @property int|null $httpStatus

lib/EasyPost/Http/Requestor.php

@@ -264,7 +264,7 @@ public static function interpretResponse(string $httpBody, int $httpStatus): mix
      */
     public static function handleApiError(?string $httpBody, int $httpStatus, array $response): void
     {
-        if (!is_array($response) || !isset($response['error'])) {
+        if (!isset($response['error'])) {
             throw new JsonException(
                 "Invalid response object from API: HTTP Status: ({$httpStatus}) {$httpBody})",
                 $httpStatus,

lib/EasyPost/Insurance.php

@@ -18,7 +18,7 @@
  * @property Address $to_address
  * @property Address $from_address
  * @property Fee $fee
- * @property array $messages
+ * @property array<string> $messages
  * @property string $created_at
  * @property string $updated_at
  */

lib/EasyPost/Order.php

@@ -15,7 +15,7 @@
  * @property Address $return_address
  * @property Address $buyer_address
  * @property Shipment[] $shipments
- * @property Rates[] $rates
+ * @property Rate[] $rates
  * @property Message[] $messages
  * @property bool $is_return
  * @property string $created_at