8.0.0 release (#57)

Author: Ian-Montgomery-Klaviyo

CHANGELOG.md

@@ -1,6 +1,34 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [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](https://developers.klaviyo.com/en/docs/apis_comparison_chart).
+
+### 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

README.md

@@ -38,8 +38,8 @@ export class AccountsApi {
 
     protected _basePath = defaultBasePath;
     protected _defaultHeaders : any = {
-        revision: "2023-12-15",
-        "User-Agent": "klaviyo-api-node/7.2.0"
+        revision: "2024-02-15",
+        "User-Agent": "klaviyo-api-node/8.0.0"
     };
     protected _useQuerystring : boolean = false;
 
@@ -71,7 +71,7 @@ export class AccountsApi {
      * Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`
      * @summary Get Account
      * @param id The ID of the account
-     * @param fieldsAccount For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
+     * @param fieldsAccount For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
      */
     public async getAccount (id: string, options: { fieldsAccount?: Array<'contact_information' | 'contact_information.default_sender_name' | 'contact_information.default_sender_email' | 'contact_information.website_url' | 'contact_information.organization_name' | 'contact_information.street_address' | 'contact_information.street_address.address1' | 'contact_information.street_address.address2' | 'contact_information.street_address.city' | 'contact_information.street_address.region' | 'contact_information.street_address.country' | 'contact_information.street_address.zip' | 'industry' | 'timezone' | 'preferred_currency' | 'public_api_key'>,  } = {}): Promise<{ response: AxiosResponse; body: GetAccountResponse;  }> {
 
@@ -125,7 +125,7 @@ export class AccountsApi {
      * Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.  You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`  **Scopes:** `accounts:read`
      * @summary Get Accounts
      
-     * @param fieldsAccount For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets
+     * @param fieldsAccount For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets
      */
     public async getAccounts (options: { fieldsAccount?: Array<'contact_information' | 'contact_information.default_sender_name' | 'contact_information.default_sender_email' | 'contact_information.website_url' | 'contact_information.organization_name' | 'contact_information.street_address' | 'contact_information.street_address.address1' | 'contact_information.street_address.address2' | 'contact_information.street_address.city' | 'contact_information.street_address.region' | 'contact_information.street_address.country' | 'contact_information.street_address.zip' | 'industry' | 'timezone' | 'preferred_currency' | 'public_api_key'>,  } = {}): Promise<{ response: AxiosResponse; body: GetAccountResponseCollection;  }> {
 

api/accountsApi.ts

@@ -21,6 +21,8 @@ export * from './metricsApi';
 import { MetricsApi } from './metricsApi';
 export * from './profilesApi';
 import { ProfilesApi } from './profilesApi';
+export * from './reportingApi';
+import { ReportingApi } from './reportingApi';
 export * from './segmentsApi';
 import { SegmentsApi } from './segmentsApi';
 export * from './tagsApi';
@@ -185,6 +187,8 @@ export function ConfigWrapper(apiKey: string, opts: {numOfAttempts?: number, tim
 
     export const Profiles = new ProfilesApi(new GlobalApiKeySession())
 
+    export const Reporting = new ReportingApi(new GlobalApiKeySession())
+
     export const Segments = new SegmentsApi(new GlobalApiKeySession())
 
     export const Tags = new TagsApi(new GlobalApiKeySession())
@@ -194,4 +198,4 @@ export function ConfigWrapper(apiKey: string, opts: {numOfAttempts?: number, tim
 
 export const Auth = { ApiKeySession, GlobalApiKeySession, GlobalApiKeySettings}
 
-export const Klaviyo = { Auth, AccountsApi, Accounts, CampaignsApi, Campaigns, CatalogsApi, Catalogs, CouponsApi, Coupons, DataPrivacyApi, DataPrivacy, EventsApi, Events, FlowsApi, Flows, ImagesApi, Images, ListsApi, Lists, MetricsApi, Metrics, ProfilesApi, Profiles, SegmentsApi, Segments, TagsApi, Tags, TemplatesApi, Templates };
+export const Klaviyo = { Auth, AccountsApi, Accounts, CampaignsApi, Campaigns, CatalogsApi, Catalogs, CouponsApi, Coupons, DataPrivacyApi, DataPrivacy, EventsApi, Events, FlowsApi, Flows, ImagesApi, Images, ListsApi, Lists, MetricsApi, Metrics, ProfilesApi, Profiles, ReportingApi, Reporting, SegmentsApi, Segments, TagsApi, Tags, TemplatesApi, Templates };