v3.2.0: Loyalty Programs pending points & sandbox/live applications

Summary

Loyalty Programs

Introduce Loyalty Program pending points, points that belong to the program's balance but will become active in the future:

• Introduce Loyalty Program setting to control default points' pending duration
• Introduce a couple of new attributes to communicate better a ledger's points status (pending, active, expired and spent)

⚠️⚠️ Breaking Change: Loyalty Program points addition payload

This version also introduced the ability to set both loyalty points pending and validity durations.
In order to communicate these more clear, we have renamed the former expiryDuration attribute of LoyaltyPoints entity to validityDuration:

$programID = 'programID_example';
$integrationID = 'integrationID_example';
$body = new \TalonOne\Client\Model\LoyaltyPoints([
  'points' => 42.42,
  'name' => 'The Answer',
-  'expiryDuration' => '3d', // 3 days
+  'validityDuration' => '3d' // 3 days
]);
$apiInstance->addLoyaltyPoints($programID, $integrationID, $body);

⚠️ Deprecation Notice: Loyalty Program Ledger's total property

Please note that we are deprecating the total property of the LoyaltySubLedger entity. In order to be more transparent and express better distinction between a customer's balance in a program (active, pending, and expired points).

We will remove this property in next versions of the SDK, please use the new totalActivePoints property instead.

Sandbox/Live Applications & Account Analytics

Applications now can be flagged as live or sandbox (available only via the web application):

• This can be seen via the sandbox attribute of the Application entity
• Account analytics now respect this separation and reports new data points: liveApplications and sandboxApplications

⚠️ Deprecation Notice: Integration API@v1 endpoints

This version also introduced the deprecation notices for Integration API@v1 endpoints:

• Update a Customer Session (V1)
• Update a Customer Profile (V1)

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.

v3.1.0: Dry Runs & Coupons discount limits

• Introduce "dry runs" for Integration API endpoints (See more details below)
• Add support to retrieve coupons as part of requesting customer profile inventories
• Add support for setting the discountLimit when creating or editing coupons
• Fix LoyaltyLedgerEntry's type property values, failing to parse when retrieving values from the API

Introducing "dry runs" for Integration API endpoints

You can read more about the concept and where this feature could apply in your integration and workflow in our developers documentation center: https://developers.talon.one/Integration-API/dry-requests

Fixes Included

• chore: Lower guzzle dependency version restriction (>= 5.3) (#4)
• fix: Fix nanoseconds when serializing timestamps (#5)

v3.0.0: Integration API V2

• Replace code generator to OpenAPITools [email protected]
• Add our new v2 integration api endpoint for customer sessions. Read more here: https://developers.talon.one/Getting-Started/APIV2
• Add v2-related management endpoints for managing AdditionalCosts

⚠️ From this version on we will publish our library also as a composer package via packagist

You can find the package page here: https://packagist.org/packages/talon-one/talon-one-client

v2.1.0

• Expose new profile inventory endpoint. Consult our developer docs for more information: https://developers.talon.one/Integration-API/API-Reference#getCustomerInventory
• Expose more attributes handling endpoints (create, update, get all)
• copyCampaignToApplications endpoint extended and now allows to override original campaign's description scheduling details and tags as part of the copy functionality. See parameters here: https://developers.talon.one/Management-API/API-Reference#copyCampaignToApplications

v2.0.2

• More filtering parameters when querying changes endpoint
• The full Coupon object is now returned as part of an integration response
• Support for new limit configuration of amount of give discount effects

v2.0.1 Introduce Coupon Reservation Endpoints

• Introduce coupon reservation endpoints under the integration api
• Tiny documentation fixes (page sizes are 1000 by default)

management api endpoints cleanup

Removed endpoints

• create_application
• update_application
• delete_application
• update_campaign
• delete_referral
• create_api_key
• delete_api_key
• get_api_keys
• renew_api_token
• create_role
• get_roles
• get_role
• update_role
• delete_role
• update_attribute
• delete_attribute
• create_webhook
• update_webhook
• delete_webhook
• delete_event_type
• update_user
• create_invite
• update_account
• get_manager_config
• update_manager_config

Added endpoints

• copy_campaign_to_applications
• get_campaign_by_attributes
• update_coupon_batch

Coupon search

• search_coupons_advanced
• search_coupons_advanced_without_total_count
• search_coupons_advanced_application_wide
• search_coupons_advanced_application_wide_without_total_count

Loyalty programs

• get_referrals_without_total_count
• get_loyalty_programs
• get_loyalty_program
• get_loyalty_points
• add_loyalty_points
• remove_loyalty_points

Misc

• get_access_logs_without_total_count
• refresh_analytics
• get_imports
• get_all_roles

Customer profiles / activity

• get_customers_by_attributes
• get_customer_profile
• get_customer_profiles
• get_application_customers_by_attributes
• get_customer_activity_reports_without_total_count

Events

• get_application_events_without_total_count
• get_application_event_types

Renamed endpoints

• delete_all_coupons -> delete_coupons

Removes extra arguments on generated code

Removes extra arguments on generated code in the management api