v9.0.0

Summary

Added endpoints

ManagementApi | create_campaign_store_budget | POST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Create campaign store budget
ManagementApi | delete_campaign_store_budgets | DELETE /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Delete campaign store budgets
ManagementApi | export_campaign_store_budgets | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export | Export campaign store budgets
ManagementApi | import_campaign_store_budget | POST /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import | Import campaign store budgets
ManagementApi | list_campaign_store_budget_limits | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | List campaign store budget limits
ManagementApi | scim_create_group | POST /v1/provisioning/scim/Groups | Create SCIM group
ManagementApi | scim_delete_group | DELETE /v1/provisioning/scim/Groups/{groupId} | Delete SCIM group
ManagementApi | scim_get_group | GET /v1/provisioning/scim/Groups/{groupId} | Get SCIM group
ManagementApi | scim_get_groups | GET /v1/provisioning/scim/Groups | List SCIM groups
ManagementApi | scim_patch_group | PATCH /v1/provisioning/scim/Groups/{groupId} | Update SCIM group attributes
ManagementApi | scim_replace_group_attributes | PUT /v1/provisioning/scim/Groups/{groupId} | Update SCIM group
ManagementApi | summarize_campaign_store_budget | GET /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary | Get summary of campaign store budgets

v8.0.0: Update pytest requirement from ~=8.3.3 to ~=8.3.4

IntegrationApi

New endpoints

get_customer_achievement_history
GET /v1/customer_profiles/{integrationId}/achievements/{achievementId}
get_customer_achievements
GET /v1/customer_profiles/{integrationId}/achievements

ManagementApi

New endpoints

get_dashboard_statistics
GET /v1/loyalty_programs/{loyaltyProgramId}/dashboard
get_message_logs
GET /v1/message_logs

Removed endpoints

notification_activation
PUT /v1/notifications/{notificationId}/activation
post_added_deducted_points_notification
POST /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points
post_catalogs_strikethrough_notification
POST /v1/applications/{applicationId}/catalogs/notifications/strikethrough
post_pending_points_notification
POST /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points

v7.0.1

Summary

Changed Endpoints

Management API

Budget on AdditionalCampaignProperties is now optional.
list[CampaignBudget] | A list of all the budgets that are defined by this campaign and their usage. Note: Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. | [optional]

v7.0.0

Summary

Removed endpoints

Management API

get_all_access_logs | GET /v1/access_logs | List access logs

v6.1.1

What's Changed

• chore: modify code sample to provide json conversion example by @rubyjohn93 in #23
• fix(TrackEventsV2): Error in python SDK track event endpoint. LedgerEntriers is not anymore a required field. by @giou-k in #27

New Contributors

• @rubyjohn93 made their first contribution in #23
• @giou-k made their first contribution in #27

Full Changelog: v6.0.0...v6.1.1

v6.0.0

Summary

New endpoints

Management API

• Activate user by email address
• Invite user from identity provider

Changes

The disabled and archived campaign states were added.

⚠️ Deprecation Notice

• The GET /v1/roles endpoint was deprecated. Please use the new one GET /v2/roles
• The GET /v1/roles/{roleId} endpoint was deprecated. Please use the new one GET /v2/roles/{roleId}

v5.0.0: Achievements

Summary

New endpoints

Integration API

• List card's unused loyalty points
• List customer's unused loyalty points

Management API

• Create store
• Delete store
• Get store
• List stores
• Update store
• Create achievement
• Delete achievement
• Export achievement customer data
• Get achievement
• List customer achievements
• List achievements
• Update achievement
• Resend invitation email
• Invite user
• Deactivate user by email address
• Delete user
• Delete user by email address
• Update role
• Update user
• Export audience members
• List audience members
• List audience analytics
• Import audience members
• Get campaign access group
• List campaign access groups
• Export customers' tier data
• Export giveaway codes of a giveaway pool
• Import customers into loyalty tiers
• List items in a catalog
• List collections in Application
• Activate or deactivate notification
• Create notification about pending loyalty points

Changes

• Create strikethrough notification endpoint path was changed to /v1/applications/{applicationId}/catalogs/notifications/strikethrough

⚠️ Deprecation Notice

• The TrackEvent endpoint /v1/events was deprecated. Please use the new endpoint /v2/events instead.
• The endpoint to create notification about campaign-related changes (POST /v1/applications/{applicationId}/notification_webhooks) was deprecated
• The endpoint to delete notification about campaign-related changes (DELETE /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}) was deprecated
• The endpoint to get notification about campaign-related changes (GET /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}) was deprecated
• The endpoint to list notifications about campaign-related changes (GET /v1/applications/{applicationId}/notification_webhooks) was deprecated
• The endpoint to update notification about campaign-related changes (PUT /v1/applications/{applicationId}/notification_webhooks/{notificationWebhookId}) was deprecated

v4.0.0: Reopen session endpoint, loyalty data integration endpoints and loyalty card management endpoints

Summary

Integration API

• Reopen customer session
• Get customer's loyalty points
• List customer's loyalty transactions
• Get card's point balances
• List card's transactions
• Link customer profile to card

Management API

• Add points to card

• Deduct points from card

• Delete loyalty card

• List loyalty cards

• Get loyalty card

• Import loyalty cards

• Transfer card data

• Update loyalty card status

• List card's transactions

• List loyalty program transactions

• Export customer loyalty balances -- please note deprecation notice blow

• Export all card transaction logs

• Export card's ledger log

⚠️ Deprecation Notice: Export customer loyalty balance to CSV endpoint

Please note that the Export customer loyalty balance to CSV endpoint is getting deprecated, please update your code to point at the new Export customer loyalty balances

v3.4.1: Fix malformed get_loyalty_transactions function response type

v3.4.1

• Fix malformed get_loyalty_transactions function response type (#18)

v3.4.0: Partial Returns, Collections, Improved customer inventory & Referral new attributes

v3.4.0

TBD

Issues closed

resolved #16