Skip to content

Latest commit

 

History

History
335 lines (247 loc) · 17 KB

CHANGELOG.md

File metadata and controls

335 lines (247 loc) · 17 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

[11.0.0] - revision 2024-07-15

Added

  • Forms API
  • New FormsApi class with methods to get forms, form versions and relationships.
  • Webhooks API
  • New WebooksApi class containing CRUD operations for webhooks.
  • FilterBuilder class
    • New class to help build filters in the correct format for endpoints that use them.
    • See the README for more information and usage examples.

Changed

  • ProfilesApi.subscribe()
  • added historicalImport flag for importing historically consented profiles can now be optionally supplied in the payload for the Subscribe Profiles endpoint.
  • When using this flag, a consentedAt date must be provided and must be in the past.

[10.1.0] - revision 2024-06-15

Added

  • Segments Api

    • New create segment endpoint SegmentsApi.createSegment().
    • New delete segment endpoint SegementsApi.deleteSegment().
    • Updated existing segments endpoints to include the segment definition
    • For more information, see our Segments API overview.

  • Flows Api

    • New delete flows endpoint FlowsApi.deleteFlow()

[10.0.0] - revision 2024-05-15

Added

  • Bulk Create Events API
    • We have added support for creating events in bulk via the EventsApi.bulkCreateEvents method
    • Create multiple events for new and existing profiles and/or update profile properties in a single API call. For more information, see our Events API overview.

Changed

  • Accounts Api

    • AccountsApi.getAccounts and AccountsApi.getAccount have been updated to return the account's locale, e.g. "en-US".

  • Breaking Subscribe API Synchronous Validation Improved

    • To provide better feedback for handling SMS subscriptions, we’ve added improved validation behavior to ProfilesApi.subscribeProfiles method. In prior revisions, such requests may appear as 202s but will fail to update SMS consent. To handle this issue, 400 validation errors are returned for the following cases
      1. If a profile is subscribed to SMS marketing and age-gating is enabled but age_gated_date_of_birth is not provided, or the DOB does not meet the region's requirements.
      2. If the account does not have a sending number in the phone number’s region.
      3. If the phone number is in a region not supported by Klaviyo.
      4. If consented_at is set and the list or global setting is double opt-in.

[9.0.0] - revision 2024-02-15

Changed

[8.0.0] - revision 2024-02-15

Added:

  • New ReportingApi allows you to request campaign and flow performance data that you can view in the Klaviyo UI.

  • campaignValuesQuery

    • Request campaign analytics data, for example, a campaign performance report on the open rate over the past 30 days.

  • flowValuesQuery

    • Request flow analytics data, for example, a flow performance report on the revenue per recipient value over the past 3 months.

  • flowSeriesQuery

    • Fetch flow series data for a specific interval and timeframe, for example, a flow performance report on weekly click rates over the past 12 months.

  • New ProfilesApi endpoint allows you to create or update a profile with a set of profile attributes.

    • createOrUpdateProfile
      • This endpoint operates synchronously and offers an upsert pattern similar to the v1/v2 Identify API.

Changed:

  • Removed the $attribution field from event_properties in get_event and get_events (breaking change).

    • To include this data in your request, add include=attributions to your request.

[7.2.0] - revision 2023-12-15

Added

  • New Endpoints: Bulk Profile Imports:
    • Profiles.spawnBulkProfileImportJob
    • Profiles.getBulkProfileImportJob
    • Profiles.getBulkProfileImportJobs
    • Profiles.getBulkProfileImportJobLists
    • Profiles.getBulkProfileImportJobProfiles
    • Profiles.getBulkProfileImportJobImportErrors
    • Profiles.getBulkProfileImportJobRelationshipsProfiles
    • Profiles.getBulkProfileImportJobRelationshipsLists

Changed

[7.1.0] - revision 2023-10-15

Changed

  • Creating objects can now take the type as a string as well as an enum 
    let profile: ProfileCreateQuery = {
  data: {
    type:  'profile',
    attributes: {
      email: "typescript_literals_test@klaviyo-demo.com"
    }
  }
}
  • Endpoints with multiple included properties will now deserialize both included objects correctly
    • i.e. eventsApi.getEvent("${EVENT_ID}", {include: ['metric', 'profile']})
  • Models that were supposed to support two primitive types but were serializing incorrectly now support one but work correctly
    • i.e. updateProfile's unset value now takes a list of strings and serializes correctly.

[7.0.0] - revision 2023-10-15

Added

  • Support for returning list suppressions via the /profiles endpoint

    Rules for suppression filtering:

    • You may not mix-and-match list and global filters
    • You may only specify a single date filter
    • You may or may not specify a reason
    • You must specify a list_id to filter on any list suppression properties

    Examples:

    {filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z)'}
{filter: 'greater-than(subscriptions.email.marketing.list_suppressions.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.list_suppressions.list_id,”LIST_ID”')
{filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.suppression.reason,"user_suppressed"')

  • Optionally retrieve subscription status on:

    • getListProfiles
    • getSegmentProfiles
    • getEventProfile

    Use {additionalFieldsProfile: ['subscriptions']} on these endpoints to include subscription information.

Changed

  • Subscription object not returned by default on Get Profile / Get Profiles

    The subscription object is no longer returned by default with get profile(s) requests. However, it can be included by adding ?additional-fields[profile]=subscriptions to the request. This change will allow us to provide a more performant experience when making requests to GetProfiles without including the subscriptions object.

  • Profile Subscription Fields Renamed

    In the interest of providing more clarity and information on the subscription object, we have renamed several fields, and added several as well. This will provide more context on a contact's subscriptions and consent, as well as boolean fields to see who you can or cannot message.

    For SMSMarketing:

    • timestamp is now consentTimestamp
    • lastUpdated is a new field that mirrors consenTimestamp
    • canReceiveSmsMarketing is a new field which is True if the profile is consented for SMS

    For EmailMarketing:

    • timestamp is now consentTimestamp
    • canReceiveEmailMarketing is True if the profile does not have a global suppression
    • suppressions is now suppression
    • lastUpdated is a new field that is the most recent of all the dates on the object

[6.0.1] - revision 2023-09-15

Fixed

  • Relationship and its child attributes were incorrectly marked as optional for the following endpoints
    • createBackInStockSubscription
    • createCampaignMessageAssignTemplate
    • spawnCreateVariantsJob
    • createCatalogVariant
    • spawnCouponCodeBulkCreateJob
    • createCouponCode
    • mergeProfiles
    • subscribeProfiles
  • Removed unused dependencies from package.json that were requiring a higher node version than necessary

[6.0.0] - revision 2023-09-15

Added

  • Typescript Support

    • Types - This is a complete rework of our node sdk to add native type support in package

  • Images API

    • We now support the following operations to work with images:
      • get_image
      • get_images
      • update_image
      • upload_image_from_file - You can use fs.createReadStream to pass the file into the function
      • upload_image_from_url

  • Coupons API

    • We now support CRUD operations for both Coupons and Coupon Codes
    • Check out Coupons API guide for more information.

  • Additional filtering/sorting option for Lists and Segments: joined_group_at

  • New profile merge endpoint: ProfilesApi.mergeProfiles

  • Increased the maximum page size limit for List and Segment Profile Relationship Endpoints to 1000

Changed

  • Authentication - Changes were made to make way for upcomming OAuth support
    • Now use ApiKeySession object to pass in the authentication into an api constructor. The readme has plenty of examples.
    • ConfigWrapper should still work it now just updates the GlobalApiKeyConfig and creates an ApiKeySession instance

[5.1.0] - revision 2023-08-15

Added

  • Flow Message Templates
    • You can now retrieve the templates associated with flow messages using Flows.getFlowMessageTemplate() or Flows.getFlowMessageRelationshipsTemplate() . You’re also able to include the template HTML for a flow message using Flows.getFlowMessage(FLOW_MESSAGE_ID, {include: ['template']}).
  • Create or Update Push Tokens
    • We have added an endpoint to create push tokens, Profiles.createPushToken(). This endpoint can be used to migrate profiles and their push tokens from another platform to Klaviyo. If you’re looking to register push tokens from users’ devices, please use our mobile SDKs.

[5.0.0] - revision 2023-07-15

Added

  • Back-In-stock APIs
  • New functionality to Campaigns API
    • CRUD support for SMS campaigns is now available
    • You can now also retrieve all messages for a campaign to determine performance data on campaigns where you're running A/B tests

Changed

  • Relationship Standardization
    • Note: this is a major refactor, affecting commonly used endpoints like createEvents. We highly recommend reading our migration guide
    • We are making a number of changes across endpoints to standardize how we handle relationships in our APIs and leverage consistently typed objects across endpoints. For example, you can create a profile in our APIs in the same shape, regardless of whether you're calling the profiles endpoint or the events endpoint.
    • The changes include:
      • Updating 1:1 relationships to use singular tense and an object (instead of plural and an array)
        • example: for get_flow_action, if you want to use the include param, you would set include= to "flow" (instead of "flows")
      • Moving related object IDs from the attributes payload to relationships
        • example: The format for the body of create_tag has changed, with tag_group_id previously at data.attributes.tag_group_id being removed and replaced by a data object containing type+id and located at data.relationships.tag-group.data.
      • Specifying a relationship between two Klaviyo objects to allow for improved consistency and greater interoperability across endpoints
        • example: for create_event, you can now create/update a profile for an event in the same way you would when using the profiles API directly
    • NOTE: The examples for the above relationship changes are illustrative, not comprehensive. For a complete list of ALL the endpoints that have changed and exactly how, please refer to our latest API Changelog
  • For get_campaigns endpoint, filter param is now required, to, at minimum, filter on messages.channel

Removed

[4.0.0] - revision 2023-06-15

Added

  • Accounts API is now available, this will allow you to access information about the Klaviyo account associated with your API key.
    • getAccounts
    • getAccount

Note: You will need to generate a new API key with either the Accounts scope enabled or Full Access to use these endpoints.

Changed

  • createProfile - opts parameter removed because there are no optional query parameter that can be passed to the endpoint

Removed

  • All client endpoints - While you could potentially get this repo to work for frontend and use only these client endpoints, it is bad practice to use client-side endpoints on the server side. In addition, developers found the inclusion of the client-side endpoints in our SDKs generally confusing.
    • createClientEvent
    • createClientProfile
    • createClientSubscription

Klaviyo has the much lighter weight klaviyo.js wrapper that we recommend for client-side use which you can read about here.

In addition, you can make client-side API calls outright if desired.

[3.0.0] - revision 2023-02-22

Added

  • Profiles API now returns predictive analytics when calling getProfile and getProfiles by passing in additionalFieldsProfile = ["predictive_analytics"].

    const response = await Profiles.getProfiles({additionalFieldsProfile: ["predictive_analytics"]})

Changed

  • Relationship endpoints that were previously grouped together are now split into related-resource-specific endpoints.

Migration Guide

  • To migrate to this latest version, all calls to relationship endpoints need to be updated, as in the following example:
    • getCampaignRelationships(campaignId, "tags") will become getCampaignRelationshipsTags(campaignId).

[2.1.1] - revision 2023-02-22

Changes

  • Multi-store
    • ConfigWrappers passed into the api wrappers now works as intended
  • PageSize is now added as an optional param to the following endpoints
    • Segments
      • getSegmentProfiles
    • Profiles
      • getProfiles
    • Lists
      • getListProfiles

[2.1.0] - revision 2023-02-22

Added

  • Campaigns (which were previously in our Beta API/SDKs)

Changes

  • Flows
    • Pagination changed from page offset to cursor

[2.0.0] - revision 2023-01-24

  • Added the following endpoints (which were previously in our Beta APIg/SDKs):
    • Data Privacy
    • All Tags endpoints, as well as the following related resource-specific endpoints:
      • Get Flow Tags
      • Get List Tags
      • Get Segment Tags
  • Reworked the response object from returned by SDK methods
    • instead of only returning the response payload, the status code and headers are now also returned
    • The API response payload is now nested under body within the API response returned by SDK methods. You can get the id of the returned resource by calling response.body.data.id instead of response.data.id from previous releases. You can get response headers and status with response.headers and response.status respectively.

[1.0.2] - revision: 2022-10-19 (update: 2022-12-19)

Changes

  • fix babel/cli location in package.json to be in devDependencies
  • when passing pageCursor the returned link.next url will be automatically parsed for the page cursor

[1.0.0] - revision: 2022-10-19

Added

  • Initial release

Changes

  • Naming changes from beta:
    • Package name: klaviyo-sdk-beta → klaviyo-api
    • Some functions have changed name
  • New resources and endpoints: