Changes from gocardless/client-library-templates

README.md

@@ -1,6 +1,6 @@
-# GoCardless Pro PHP client library
+# GoCardless PHP client library
 
-A PHP client for interacting with the GoCardless Pro API.
+A PHP client for interacting with the GoCardless API.
 
 [![PHP version](https://badge.fury.io/ph/gocardless%2Fgocardless-pro.svg)](https://badge.fury.io/ph/gocardless%2Fgocardless-pro)
 [![CircleCI](https://circleci.com/gh/gocardless/gocardless-pro-php.svg?style=shield)](https://circleci.com/gh/gocardless/gocardless-pro-php)
@@ -236,6 +236,18 @@ try {
 }
 ```
 
+#### Accessing the webhook ID
+
+If you need to access the webhook ID for debugging purposes, you can use `Webhook::parseWithMeta` instead:
+
+```php
+$result = GoCardlessPro\Webhook::parseWithMeta($request_body, $signature_header, $webhook_endpoint_secret);
+$events = $result->getEvents();
+$webhookId = $result->getWebhookId(); // e.g. "WB123" - useful for debugging
+```
+
+Note: The webhook ID is intended for debugging and logging purposes only. It should not be used for deduplication - instead, use the event IDs to deduplicate, as each event has a unique ID that remains consistent if the same event is sent multiple times.
+
 For more details on working with webhooks, see our ["Getting started" guide](https://developer.gocardless.com/getting-started/api/introduction/?lang=php).
 
 ## Supporting PHP >= 8.1

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "gocardless/gocardless-pro",
   "description": "GoCardless PHP Client Library",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "keywords": [
     "gocardless",
     "direct debit",

lib/Client.php

@@ -24,7 +24,7 @@ class Client
      */
     public function __construct($config)
     {
-        $this->validate_config($config);
+        $this->validateConfig($config);
 
         $access_token = $config['access_token'];
 
@@ -56,7 +56,7 @@ public function __construct($config)
                 'Content-Type' => 'application/json',
                 'Authorization' => "Bearer " . $access_token,
                 'GoCardless-Client-Library' => 'gocardless-pro-php',
-                'GoCardless-Client-Version' => '7.2.0',
+                'GoCardless-Client-Version' => '7.3.0',
                 'User-Agent' => $this->getUserAgent()
               ),
               'http_errors' => false,
@@ -125,6 +125,10 @@ public function __construct($config)
 
         $this->services['outbound_payments'] = new Services\OutboundPaymentsService($this->api_client);
 
+        $this->services['outbound_payment_imports'] = new Services\OutboundPaymentImportsService($this->api_client);
+
+        $this->services['outbound_payment_import_entries'] = new Services\OutboundPaymentImportEntriesService($this->api_client);
+
         $this->services['payer_authorisations'] = new Services\PayerAuthorisationsService($this->api_client);
 
         $this->services['payer_themes'] = new Services\PayerThemesService($this->api_client);
@@ -495,6 +499,30 @@ public function outboundPayments()
         return $this->services['outbound_payments'];
     }
 
+    /**
+     * Service for interacting with outbound payment imports
+     * @return Services\OutboundPaymentImportsService
+     */
+    public function outboundPaymentImports()
+    {
+        if (!isset($this->services['outbound_payment_imports'])) {
+            throw new \Exception('Key outbound_payment_imports does not exist in services array');
+        }
+        return $this->services['outbound_payment_imports'];
+    }
+
+    /**
+     * Service for interacting with outbound payment import entries
+     * @return Services\OutboundPaymentImportEntriesService
+     */
+    public function outboundPaymentImportEntries()
+    {
+        if (!isset($this->services['outbound_payment_import_entries'])) {
+            throw new \Exception('Key outbound_payment_import_entries does not exist in services array');
+        }
+        return $this->services['outbound_payment_import_entries'];
+    }
+
     /**
      * Service for interacting with payer authorisations
      * @return Services\PayerAuthorisationsService
@@ -706,7 +734,7 @@ private function getUrlForEnvironment($environment)
      *
      * @param array[string]mixed $config the client configuration options
      */
-    private function validate_config(&$config)
+    private function validateConfig(&$config)
     {
         $required_option_keys = array('access_token', 'environment');
 
@@ -736,7 +764,7 @@ private function getUserAgent()
     {
         $curlinfo = curl_version();
         $uagent = array();
-        $uagent[] = 'gocardless-pro-php/7.2.0';
+        $uagent[] = 'gocardless-pro-php/7.3.0';
         $uagent[] = 'schema-version/2015-07-06';
         if (defined('\GuzzleHttp\Client::MAJOR_VERSION')) {
             $uagent[] = 'GuzzleHttp/' . \GuzzleHttp\Client::MAJOR_VERSION;

lib/Core/ApiClient.php

@@ -125,14 +125,14 @@ private function handleErrors(Response $response)
             return null;
         }
 
+        $status_code = $response->getStatusCode();
         $json = json_decode($response->getBody());
 
         if ($json === null) {
             $msg = "Malformed response received from server";
-            throw new Exception\MalformedResponseException($msg, $response);
+            throw new Exception\MalformedResponseException($msg, $response, $status_code);
         }
 
-        $status_code = $response->getStatusCode();
         if ($status_code < 400) {
             return null;
         }

lib/Core/Exception/ApiConnectionException.php

@@ -4,4 +4,4 @@
 
 class ApiConnectionException extends GoCardlessProException
 {
-};
+}

lib/Core/Exception/AuthenticationException.php

@@ -4,4 +4,4 @@
 
 class AuthenticationException extends InvalidApiUsageException
 {
-};
+}

lib/Core/Exception/GoCardlessInternalException.php

@@ -4,4 +4,4 @@
 
 class GoCardlessInternalException extends ApiException
 {
-};
+}

lib/Core/Exception/GoCardlessProException.php

@@ -4,4 +4,4 @@
 
 class GoCardlessProException extends \Exception
 {
-};
+}

lib/Core/Exception/InvalidApiUsageException.php

@@ -4,4 +4,4 @@
 
 class InvalidApiUsageException extends ApiException
 {
-};
+}

lib/Core/Exception/InvalidSignatureException.php

@@ -4,4 +4,4 @@
 
 class InvalidSignatureException extends GoCardlessProException
 {
-};
+}

lib/Core/Exception/InvalidStateException.php

@@ -26,4 +26,4 @@ private function getIdempotentCreationConflictError()
             }
         }
     }
-};
+}

lib/Core/Exception/MalformedResponseException.php

@@ -4,17 +4,47 @@
 
 class MalformedResponseException extends GoCardlessProException
 {
+    const BODY_PREVIEW_MAX_LENGTH = 500;
+
     private $response;
+    private $statusCode;
 
-    public function __construct($message, $response)
+    public function __construct($message, $response, $statusCode = null)
     {
         $this->response = $response;
-        parent::__construct($message);
+        $this->statusCode = $statusCode;
+        parent::__construct(self::buildMessage($message, $response, $statusCode));
     }
 
 
     public function response()
     {
         return $this->response;
     }
-};
+
+    public function statusCode()
+    {
+        return $this->statusCode;
+    }
+
+    private static function buildMessage($message, $response, $statusCode)
+    {
+        $full = $message;
+        if ($statusCode !== null) {
+            $full .= ' (HTTP ' . $statusCode . ')';
+        }
+        $body = null;
+        if (is_string($response)) {
+            $body = $response;
+        } elseif (is_object($response) && method_exists($response, 'getBody')) {
+            $body = (string) $response->getBody();
+        }
+        if ($body !== null && $body !== '') {
+            if (strlen($body) > self::BODY_PREVIEW_MAX_LENGTH) {
+                $body = substr($body, 0, self::BODY_PREVIEW_MAX_LENGTH) . '...';
+            }
+            $full .= ': ' . $body;
+        }
+        return $full;
+    }
+}

lib/Core/Exception/PermissionsException.php

@@ -4,4 +4,4 @@
 
 class PermissionsException extends InvalidApiUsageException
 {
-};
+}

lib/Core/Exception/RateLimitException.php

@@ -4,4 +4,4 @@
 
 class RateLimitException extends InvalidApiUsageException
 {
-};
+}

lib/Core/Exception/ValidationFailedException.php

@@ -12,4 +12,4 @@ protected function extractErrorMessage($error)
             return $error->message;
         }
     }
-};
+}

lib/Core/Paginator.php

@@ -11,7 +11,7 @@ class Paginator implements \Iterator
     /**
     * Default max records to retrieve per page
     */
-    const HARD_RECORD_LIMIT = 500;
+    public const HARD_RECORD_LIMIT = 500;
 
     /**
     * @var \GoCardlessPro\Services\BaseService The resource service to fetch records with
@@ -63,7 +63,7 @@ public function rewind()
     {
         $this->current_position = 0;
         $this->current_page_position = 0;
-        $this->current_response = $this->initial_response();
+        $this->current_response = $this->initialResponse();
     }
 
     /**
@@ -74,7 +74,7 @@ public function rewind()
     #[\ReturnTypeWillChange]
     public function current()
     {
-        return $this->current_records()[$this->key()];
+        return $this->currentRecords()[$this->key()];
     }
 
     /**
@@ -98,7 +98,7 @@ public function next()
         ++$this->current_position;
 
         if (!$this->valid()) {
-            $this->current_response = $this->next_response();
+            $this->current_response = $this->nextResponse();
             $this->current_page_position = $this->current_position;
         }
     }
@@ -112,15 +112,15 @@ public function next()
     public function valid()
     {
         return !is_null($this->current_response) &&
-            array_key_exists($this->key(), $this->current_records());
+            array_key_exists($this->key(), $this->currentRecords());
     }
 
     /**
      * Fetch the first page of results
      *
      * @return ListResponse
      */
-    private function initial_response()
+    private function initialResponse()
     {
         $options = $this->options;
         $options['params']['after'] = null;
@@ -132,7 +132,7 @@ private function initial_response()
      *
      * @return ListResponse
      */
-    private function next_response()
+    private function nextResponse()
     {
         $options = $this->options;
         $options['params']['after'] = $this->current_response->after;
@@ -148,7 +148,7 @@ private function next_response()
      *
      * @return \GoCardlessPro\Resources\BaseResource[]
      */
-    private function current_records()
+    private function currentRecords()
     {
         return $this->current_response->records;
     }

lib/Resources/Balance.php

@@ -50,7 +50,7 @@ class Balance extends BaseResource
     protected $balance_type;
 
     /**
-     * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency
      * code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD"
      * are supported.
      */

lib/Resources/BillingRequestTemplate.php

@@ -59,7 +59,7 @@ class BillingRequestTemplate extends BaseResource
     protected $mandate_request_constraints;
 
     /**
-     * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency
      * code.
      */
     protected $mandate_request_currency;
@@ -88,31 +88,7 @@ class BillingRequestTemplate extends BaseResource
     protected $mandate_request_scheme;
 
     /**
-     * Verification preference for the mandate. One of:
-     * <ul>
-     *   <li>`minimum`: only verify if absolutely required, such as when part of
-     * scheme rules</li>
-     *   <li>`recommended`: in addition to `minimum`, use the GoCardless payment
-     * intelligence solution to decide if a payer should be verified</li>
-     *   <li>`when_available`: if verification mechanisms are available, use
-     * them</li>
-     *   <li>`always`: as `when_available`, but fail to create the Billing
-     * Request if a mechanism isn't available</li>
-     * </ul>
-     *
-     * By default, all Billing Requests use the `recommended` verification
-     * preference. It uses GoCardless payment intelligence solution to determine
-     * if a payer is fraudulent or not. The verification mechanism is based on
-     * the response and the payer may be asked to verify themselves. If the
-     * feature is not available, `recommended` behaves like `minimum`.
-     *
-     * If you never wish to take advantage of our reduced risk products and
-     * Verified Mandates as they are released in new schemes, please use the
-     * `minimum` verification preference.
-     *
-     * See [Billing Requests: Creating Verified
-     * Mandates](https://developer.gocardless.com/getting-started/billing-requests/verified-mandates/)
-     * for more information.
+     * Verification preference for the mandate.
      */
     protected $mandate_request_verify;
 
@@ -134,7 +110,7 @@ class BillingRequestTemplate extends BaseResource
     protected $payment_request_amount;
 
     /**
-     * [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency
      * code. `GBP` and `EUR` supported; `GBP` with your customers in the UK and
      * for `EUR` with your customers in supported Eurozone countries only.
      */