Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
v3.4.0: Multiple personal coupons creation endpoint, Loyalty and Refe…
…rrals counters and Export Endpoints (#9) <i id="toc"></i> ## Summary - [Management API](#user-content-management-api) - [Introduce `createCouponsForMultipleRecipients` Endpoint](#user-content-introduce-createcouponsformultiplerecipients) - [Expose Export Endpoints](#user-content-expose-export-endpoints) - [Expose `destroySession` Endpoint](#user-content-expose-destroysession) - [Introduce loyalty effects related and referrals creation counters](#user-content-introduce-counters) - [Breaking Change: Fix Campaign's `discountCount` type from `int` to `float`](#user-content-fix-discount-type) - [Integration API](#user-content-integration-api) - [Improve Responses Transparency](#user-content-improve-responses) - [Attach Loyalty Program ID in responses](#user-content-attach-loyalty-id) - [A reminder of The Deprecation Notice: Integration API@v1 endpoints](#user-content-deprecation-reminder) <i id="management-api"></i> ## Management API <i id="introduce-createCouponsForMultipleRecipients"></i> ### Introduce [`createCouponsForMultipleRecipients`](https://developers.talon.one/Management-API/API-Reference#createCouponsForMultipleRecipients) Endpoint An endpoint to allow creation of multiple coupons of the same configuration for up to 1,000 recipients at once. [☝️ Back to Table of Contents](#user-content-toc) <i id="expose-export-endpoints"></i> ### Expose export endpoints as integral part of the SDK All of our CSV export endpoints are accessible via the Web Application from the corresponding entity pages (refer to our [Help Center](https://help.talon.one/hc/en-us/articles/360010114599-Import-and-Export-Coupons#ExportExistingCodes) for an example regarding Coupons). Now these are also available endpoints as part of the SDK (links to our developer docs): - [Coupons Export](https://developers.talon.one/Management-API/API-Reference#exportCoupons) - [Customer Sessions Export](https://developers.talon.one/Management-API/API-Reference#exportCustomerSessions) - [Effects Export](https://developers.talon.one/Management-API/API-Reference#exportEffects) - [Customer Loyalty Balance Export](https://developers.talon.one/Management-API/API-Reference#exportLoyaltyBalance) - [Customer Loyalty Ledgers Log Export](https://developers.talon.one/Management-API/API-Reference#exportLoyaltyLedger) Example code snippet demonstrating consuming and printing the lines of a _Customer Loyalty Balance Export_: ```php // ...preparing api client... // An example could be seen at the repository's README file: https://github.com/talon-one/TalonOnePHPsdk#management-api $loyalty_program_id = '1'; $export_data = $managerApi->exportLoyaltyBalance($loyalty_program_id); $csv = str_getcsv($export_data); $headers = array_shift($csv); // extracting headers and remove their line foreach ($csv as $line) { // do something with line... print_r($line); } ``` One can also map the contents into object per line, with the headers as the object's keys using the snippet in the following [link](https://www.php.net/manual/en/function.str-getcsv.php#117692) [☝️ Back to Table of Contents](#user-content-toc) <i id="expose-destroySession"></i> ### Expose [`destroySession`](https://developers.talon.one/Management-API/API-Reference#destroySession) Endpoint Expose an existing endpoint to allow destroying a bearer token used in the context of the management-api. This endpoint imitates a "logout" function and will make the attached token invalid for consequent requests. [☝️ Back to Table of Contents](#user-content-toc) <i id="introduce-counters"></i> ### Introduce loyalty effects related and referrals creation counters on Campaign entities As part of the newly added budgets to campaigns (see relevant [Help Center Section](https://help.talon.one/hc/en-us/articles/360010114779-Campaign-Budget#LoyaltyLimits)), we have added new counters on campaigns with regard to loyalty and referrals: - `createdLoyaltyPointsCount` : Total number of loyalty points created by rules in this campaign - `createdLoyaltyPointsEffectCount` : Total number of loyalty point creation effects triggered by rules in this campaign - `redeemedLoyaltyPointsCount` : Total number of loyalty points redeemed by rules in this campaign - `redeemedLoyaltyPointsEffectCount` : Total number of loyalty point redemption effects triggered by rules in this campaign - `referralCreationCount` : Total number of referrals created by rules in this campaign [☝️ Back to Table of Contents](#user-content-toc) <i id="fix-discount-type"></i> ###⚠️ ⚠️ Breaking Change: Fix Campaign's `discountCount` type from `int` to `float` Campaign's `discountCount` counter property was all along calculated as a floating decimal number by our system. From this release on the returned values will be floating decimals and not cut-off integers: ```diff - **discountCount** | **int** | Total amount of discounts redeemed in the campaign. | [optional] + **discountCount** | **float** | Total amount of discounts redeemed in the campaign. | [optional] ``` [☝️ Back to Table of Contents](#user-content-toc) <i id="integration-api"></i> ## Integration API <i id="improve-responses"></i> ### Improve Responses Transparency We are constantly extending and improving our integration API to provide our consumers with the best transparency regarding what exactly has happened within their requests. We have added new data points to our **v2 endpoints** effects in order to improve the transparency we aspire for: - If an effect was triggered because of a specific coupon the effect will now include this coupon ID, see [`Effect.md`](https://github.com/talon-one/TalonOnePHPsdk/blob/9b563a90e5bb7db63b6abfc316ada2a1abb10ab2/docs/Model/Effect.md#L12) - When a coupon is rejected we attach more details regarding the origin of the failure in [`RejectCouponEffectProps`](https://github.com/talon-one/TalonOnePHPsdk/blob/9b563a90e5bb7db63b6abfc316ada2a1abb10ab2/docs/Model/RejectCouponEffectProps.md#L9-L11): - `conditionIndex` - The index of the condition that caused the rejection of the coupon - `effectIndex` - The index of the effect that caused the rejection of the coupon - `details` - More details about the failure (if available) - The same applies for referrals, when a referral is rejected we attach more details regarding the origin of the failure in [`RejectReferralEffectProps`](https://github.com/talon-one/TalonOnePHPsdk/blob/9b563a90e5bb7db63b6abfc316ada2a1abb10ab2/docs/Model/RejectReferralEffectProps.md#L9-L11): - `conditionIndex` - The index of the condition that caused the rejection of the referral - `effectIndex` - The index of the effect that caused the rejection of the referral - `details` - More details about the failure (if available) Moreover, we have introduced a [new response content](https://github.com/talon-one/TalonOnePHPsdk/blob/9b563a90e5bb7db63b6abfc316ada2a1abb10ab2/lib/Model/IntegrationRequest.php#L174), `ruleFailureReasons`, which when requested will attach to the response a collection containing **all failed rules**, with details (see the [`ruleFailureReason` model](https://github.com/talon-one/TalonOnePHPsdk/blob/9b563a90e5bb7db63b6abfc316ada2a1abb10ab2/docs/Model/RuleFailureReason.md) to help narrowing down failures and further debugging efforts to a specific single condition or effect that caused the failure. _One "gotcha" to keep in mind_: in order to maximize transparency, and due to the fact that we do not know in advance which campaign in the application the request targets, the list contains a collection of **all** failure reasons. Meaning that, it might have "white noise" with data about failures that could be considered as "obvious" to the consumer. Therefore, we suggest always filtering the list by the campaign id that was expected to trigger and did not. [☝️ Back to Table of Contents](#user-content-toc) <i id="attach-loyalty-id"></i> ### Attach Loyalty Program ID in responses When the consumer requires that the response will contain the details of loyalty programs involved in processing the requests, we now attach the identifier of the loyalty program to the returned [`loyaltyProgramLedgers` models](https://github.com/talon-one/TalonOnePHPsdk/blob/9b563a90e5bb7db63b6abfc316ada2a1abb10ab2/docs/Model/LoyaltyProgramLedgers.md#L7). The idea behind attaching the identifier is to help streamline further potential requests to our Management API with regard to details about a Loyalty Program, for example [getLoyaltyStatistics](https://developers.talon.one/Management-API/API-Reference#getLoyaltyStatistics) or [getLoyaltyPoints](https://developers.talon.one/Management-API/API-Reference#getLoyaltyPoints), that require the program identifier as part of the URI of the endpoint. [☝️ Back to Table of Contents](#user-content-toc) <i id="deprecation-reminder"></i> ###⚠️ A reminder of The Deprecation Notice: Integration API@v1 endpoints The deprecation was introduced already in the last release of the SDK, here is a kind reminder of the deprecation notices for Integration API@v1 endpoints: - [Update a Customer Session (V1)](https://github.com/talon-one/TalonOnePHPsdk/blob/master/docs/Api/IntegrationApi.md#updateCustomerSession) - [Update a Customer Profile (V1)](https://github.com/talon-one/TalonOnePHPsdk/blob/master/docs/Api/IntegrationApi.md#updateCustomerProfile) These endpoints will be flagged deprecated on _15.07.2021_, meaning support for requests to these endpoints will end on that date. **We will not remove the endpoints**, and they will still be accessible for you to use. We highly encourage migrating to the correspondent v2 endpoints for easier and more granular integration, as well as new features support (See [our developer docs section](https://developers.talon.one/Getting-Started/APIV2) about API V2.0). [☝️ Back to Table of Contents](#user-content-toc)
- Loading branch information
