Merge pull request #46 from LoginRadius/php-sdk-11.7.0

Php sdk 11.7.0

Author: indrasen715

CHANGELOG.md

@@ -1,5 +1,37 @@
 > **LoginRadius PHP SDK Change Log** provides information regarding what has changed, more specifically what changes, improvements and bug fix has been made to the SDK. For more details please refer to the [LoginRadius API Documention](https://www.loginradius.com/docs/api/v2/deployment/sdk-libraries/php-library/)
 
+# Version 11.7.0
+
+**Release Date:** March 24, 2025
+
+## Enhancements
+
+We've introduced a brand-new set of Webhook APIs, designed with enhanced functionality and flexibility. These new APIs support advanced features including:
+
+- Custom header configuration  
+- Query parameter support  
+- Webhook authentication methods (Bearer Token and Basic Auth)  
+- Support for a custom `Name` parameter to label each webhook subscription
+
+As part of this upgrade, the legacy Webhook APIs have been deprecated in favor of the new, more robust versions.
+
+## Newly Added APIs
+
+- `getWebhookSubscriptionDetail` – Retrieve detailed information about a specific webhook subscription  
+- `createWebhookSubscription` – Create a new webhook subscription with advanced configuration options  
+- `deleteWebhookSubscription` – Remove an existing webhook subscription  
+- `updateWebhookSubscription` – Modify an existing webhook subscription  
+- `listAllWebhooks` – Retrieve a list of all configured webhook subscriptions  
+- `getWebhookEvents` – Fetch available webhook events supported by the system  
+
+## Deprecated APIs
+
+The following legacy APIs have been deprecated:
+
+- `webHookUnsubscribe`  
+- `webhookTest`  
+- `webHookSubscribe`  
+- `getWebHookSubscribedURLs`  
 
 # Version 11.6.0
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2022 LoginRadius Inc.
+Copyright (c) 2025 LoginRadius Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -37,7 +37,7 @@ curl -sS https://getcomposer.org/installer | php
 Next, run the Composer command to install the latest stable version of library:
 
 ```
-composer require loginradius/php-sdk:11.6.0
+composer require loginradius/php-sdk:11.7.0
 ```
 
 Include the following files in your Project Directory
@@ -3904,71 +3904,128 @@ $result = $nativeSocialAPI->getAccessTokenByGoogleAuthCode($google_authcode,$soc
 ### WebHook API
 
 List of APIs in this Section:<br>
-[POST : Webhook Subscribe](#WebHookSubscribe-post-)<br>
-[GET : Webhook Subscribed URLs](#GetWebHookSubscribedURLs-get-)<br>
-[GET : Webhook Test](#WebhookTest-get-)<br>
-[DELETE : WebHook Unsubscribe](#WebHookUnsubscribe-delete-)<br>
+
+### WebHook API
+
+List of APIs in this Section:<br>
+[PUT : Update Webhook Subscription](#UpdateWebhookSubscription-put-)<br>
+[POST : Create Webhook Subscription](#CreateWebhookSubscription-post-)<br>
+[GET : Get Webhook Subscription Detail](#GetWebhookSubscriptionDetail-get-)<br>
+[GET : List All Webhooks](#ListAllWebhooks-get-)<br>
+[GET : Get Webhook Events](#GetWebhookEvents-get-)<br>
+[DELETE : Delete Webhook Subscription](#DeleteWebhookSubscription-delete-)<br>
 
 If you have not already initialized the WebHook object do so now
 ```php
 $webHookAPI = new WebHookAPI(); 
 ```
 
 
-<h6 id="WebHookSubscribe-post-">Webhook Subscribe (POST)</h6> 
+<h6 id="UpdateWebhookSubscription-put-">Update Webhook Subscription (PUT)</h6>
+
+This API is used to update a webhook subscription
+ [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/update-webhook-subscription/)
+
+ ```php
+ 
+$hookId = "hookId"; //Required
+ $payload = '{
+    "Headers": {
+        "x-test-header": "qa"
+    },
+    "QueryParams": {
+        "apikey": "859faf40a7c54c209360b45376bf529f"
+    },
+    "Authentication": {
+        "AuthType": "Basic",
+        "BasicAuth": {
+        "Username": "lrqaadmin",
+        "Password": "ZBz6JcnZadxc2gB7sf5vby87zBIu6q"
+        }
+    }
+}';  //Required
+ 
+$result = $webHookAPI->updateWebhookSubscription($hookId,$payload);
+ ```
+
+ 
+<h6 id="CreateWebhookSubscription-post-">Create Webhook Subscription (POST)</h6>
 
-API can be used to configure a WebHook on your LoginRadius site. Webhooks also work on subscribe and notification model, subscribe your hook and get a notification. Equivalent to RESThook but these provide security on basis of signature and RESThook work on unique URL. Following are the events that are allowed by LoginRadius to trigger a WebHook service call.
- [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/webhook-subscribe)
+This API is used to create a new webhook subscription on your LoginRadius site.
+ [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/create-webhook-subscription/)
 
  ```php
 
  $payload = '{
-"event" : "<event>",
-"targetUrl" : "<targetUrl>"
+    "event" : "<event>",
+    "name" : "<name>",
+    "targetUrl" : "<targetUrl>",
+    "Headers": {
+    "Custom-Header": "headerValue"
+    },
+    "QueryParams": {
+        "apikey": "yourApiKey"
+     },
+    "Authentication": {
+        "AuthType": "Basic",
+        "BasicAuth": {
+        "Username": "yourUsername",
+        "Password": "yourPassword"
+        }
+    }
 }';  //Required
 
-$result = $webHookAPI->webHookSubscribe($payload);
+$result = $webHookAPI->createWebhookSubscription($payload);
  ```
 
 
-<h6 id="GetWebHookSubscribedURLs-get-">Webhook Subscribed URLs (GET)</h6> 
+<h6 id="GetWebhookSubscriptionDetail-get-">Get Webhook Subscription Detail (GET)</h6>
 
-This API is used to fatch all the subscribed URLs, for particular event
- [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/webhook-subscribed-urls)
+This API is used to get details of a webhook subscription by Id
+ [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/get-webhook-subscription-details/)
 
  ```php
 
-$event = "event"; //Required
+$hookId = "hookId"; //Required
 
-$result = $webHookAPI->getWebHookSubscribedURLs($event);
+$result = $webHookAPI->getWebhookSubscriptionDetail($hookId);
  ```
 
 
-<h6 id="WebhookTest-get-">Webhook Test (GET)</h6> 
+<h6 id="ListAllWebhooks-get-">List All Webhooks (GET)</h6>
 
-API can be used to test a subscribed WebHook.
- [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/webhook-test)
+This API is used to get the list of all the webhooks
+ [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/list-all-webhooks/)
 
  ```php
 
 
-$result = $webHookAPI->webhookTest();
+$result = $webHookAPI->listAllWebhooks();
  ```
 
 
-<h6 id="WebHookUnsubscribe-delete-">WebHook Unsubscribe (DELETE)</h6> 
+<h6 id="GetWebhookEvents-get-">Get Webhook Events (GET)</h6>
 
-API can be used to unsubscribe a WebHook configured on your LoginRadius site.
- [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/webhook-unsubscribe)
+This API is used to retrieve all the webhook events.
+ [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/get-webhook-events/)
 
  ```php
 
- $payload = '{
-"event" : "<event>",
-"targetUrl" : "<targetUrl>"
-}';  //Required
 
-$result = $webHookAPI->webHookUnsubscribe($payload);
+$result = $webHookAPI->getWebhookEvents();
+ ```
+
+ 
+<h6 id="DeleteWebhookSubscription-delete-">Delete Webhook Subscription (DELETE)</h6>
+
+This API is used to delete webhook subscription
+ [More Info](https://www.loginradius.com/docs/api/v2/integrations/webhooks/delete-webhook-subscription/)
+
+ ```php
+ 
+$hookId = "hookId"; //Required
+ 
+$result = $webHookAPI->deleteWebhookSubscription($hookId);
  ```
 
 

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "loginradius/php-sdk",
-    "description": "LoginRadius PHP SDK v11.6.0",
+    "description": "LoginRadius PHP SDK v11.7.0",
     "keywords": ["loginradius", "phpsdk"],
     "type": "library",
     "license": "MIT",

src/LoginRadiusSDK/CustomerRegistration/Advanced/WebHookAPI.php

@@ -23,37 +23,33 @@ public function __construct($options = [])
 
 
     /**
-     * This API is used to fatch all the subscribed URLs, for particular event
-     * @param event Allowed events: Login, Register, UpdateProfile, ResetPassword, ChangePassword, emailVerification, AddEmail, RemoveEmail, BlockAccount, DeleteAccount, SetUsername, AssignRoles, UnassignRoles, SetPassword, LinkAccount, UnlinkAccount, UpdatePhoneId, VerifyPhoneNumber, CreateCustomObject, UpdateCustomobject, DeleteCustomObject
-     * @return Response Containing List of Webhhook Data
+     * This API is used to get details of a webhook subscription by Id
+     * @param hookId Unique ID of the webhook
+     * @return Response containing Definition for Complete WebHook data
      * 40.1
     */
 
-    public function getWebHookSubscribedURLs($event)
+    public function getWebhookSubscriptionDetail($hookId)
     {
-        $resourcePath = "/api/v2/webhook";
+        $resourcePath = "/v2/manage/webhooks/$hookId";
         $queryParam = [];
         $queryParam['apikey'] = Functions::getApiKey();
         $queryParam['apisecret'] = Functions::getApiSecret();
-        if ($event === '' || ctype_space($event)) {
-            throw new LoginRadiusException(Functions::paramValidationMsg('event'));
-        }
-        $queryParam['event'] = $event;
         return Functions::_apiClientHandler('GET', $resourcePath, $queryParam);
     }
 
 
 
     /**
-     * API can be used to configure a WebHook on your LoginRadius site. Webhooks also work on subscribe and notification model, subscribe your hook and get a notification. Equivalent to RESThook but these provide security on basis of signature and RESThook work on unique URL. Following are the events that are allowed by LoginRadius to trigger a WebHook service call.
+     * This API is used to create a new webhook subscription on your LoginRadius site.
      * @param webHookSubscribeModel Model Class containing Definition of payload for Webhook Subscribe API
-     * @return Response containing Definition of Complete Validation data
+     * @return Response containing Definition for Complete WebHook data
      * 40.2
     */
 
-    public function webHookSubscribe($webHookSubscribeModel)
+    public function createWebhookSubscription($webHookSubscribeModel)
     {
-        $resourcePath = "/api/v2/webhook";
+        $resourcePath = "/v2/manage/webhooks";
         $queryParam = [];
         $queryParam['apikey'] = Functions::getApiKey();
         $queryParam['apisecret'] = Functions::getApiSecret();
@@ -63,36 +59,72 @@ public function webHookSubscribe($webHookSubscribeModel)
 
 
     /**
-     * API can be used to test a subscribed WebHook.
-     * @return Response containing Definition of Complete Validation data
+     * This API is used to delete webhook subscription
+     * @param hookId Unique ID of the webhook
+     * @return Response containing Definition of Delete Request
      * 40.3
     */
 
-    public function webhookTest()
+    public function deleteWebhookSubscription($hookId)
     {
-        $resourcePath = "/api/v2/webhook/test";
+        $resourcePath = "/v2/manage/webhooks/$hookId";
         $queryParam = [];
         $queryParam['apikey'] = Functions::getApiKey();
         $queryParam['apisecret'] = Functions::getApiSecret();
-        return Functions::_apiClientHandler('GET', $resourcePath, $queryParam);
+        return Functions::_apiClientHandler('DELETE', $resourcePath, $queryParam);
     }
 
 
 
     /**
-     * API can be used to unsubscribe a WebHook configured on your LoginRadius site.
-     * @param webHookSubscribeModel Model Class containing Definition of payload for Webhook Subscribe API
-     * @return Response containing Definition of Delete Request
+     * This API is used to update a webhook subscription
+     * @param hookId Unique ID of the webhook
+     * @param webHookSubscriptionUpdateModel Model Class containing Definition for WebHookSubscriptionUpdateModel Property
+     * @return Response containing Definition for Complete WebHook data
      * 40.4
     */
 
-    public function webHookUnsubscribe($webHookSubscribeModel)
+    public function updateWebhookSubscription($hookId, $webHookSubscriptionUpdateModel)
+    {
+        $resourcePath = "/v2/manage/webhooks/$hookId";
+        $queryParam = [];
+        $queryParam['apikey'] = Functions::getApiKey();
+        $queryParam['apisecret'] = Functions::getApiSecret();
+        return Functions::_apiClientHandler('PUT', $resourcePath, $queryParam, $webHookSubscriptionUpdateModel);
+    }
+       
+
+
+    /**
+     * This API is used to get the list of all the webhooks
+     * @return Response Containing List of Webhhook Data
+     * 40.5
+    */
+
+    public function listAllWebhooks()
     {
-        $resourcePath = "/api/v2/webhook";
+        $resourcePath = "/v2/manage/webhooks";
         $queryParam = [];
         $queryParam['apikey'] = Functions::getApiKey();
         $queryParam['apisecret'] = Functions::getApiSecret();
-        return Functions::_apiClientHandler('DELETE', $resourcePath, $queryParam, $webHookSubscribeModel);
+        return Functions::_apiClientHandler('GET', $resourcePath, $queryParam);
+    }
+       
+
+
+    /**
+     * This API is used to retrieve all the webhook events.
+     * @return Model Class containing Definition for WebHookEventModel Property
+     * 40.6
+    */
+
+    public function getWebhookEvents()
+    {
+        $resourcePath = "/v2/manage/webhooks/events";
+        $queryParam = [];
+        $queryParam['apikey'] = Functions::getApiKey();
+        $queryParam['apisecret'] = Functions::getApiSecret();
+        return Functions::_apiClientHandler('GET', $resourcePath, $queryParam);
     }
 
 }

src/LoginRadiusSDK/Utility/Functions.php

@@ -22,7 +22,7 @@
 class Functions
 {
 
-    const VERSION = '11.6.0';
+    const VERSION = '11.7.0';
 
     private static $_apikey;
     private static $_apisecret;