version 14.0.0

Author: klaviyo-sdk

CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [14.0.0] - 2024-10-15
+### Changed
+- **Breaking:** Providing `RetryWithExponentialBackoff` class for smart retries to replace the `RetryOptions` wrapper around the `exponential-backoff` package
+- **Breaking:** renamed several models:
+  - `GetCampaignMessageTemplateRelationshipListResponse` -> `GetCampaignMessageTemplateRelationshipResponse`
+  - `GetListFlowTriggersRelationshipResponseCollection` -> `GetListFlowTriggersRelationshipsResponseCollection`
+  - `GetMetricFlowTriggersRelationshipResponseCollection` -> `GetMetricFlowTriggersRelationshipsResponseCollection`
+  - `PostListCreateResponseDataRelationshipsFlowTriggers` -> `GetMetricResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsFlowTriggers`
+  - `GetMetricFlowTriggersRelationshipResponseCollectionDataInner` -> `GetMetricResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsFlowTriggersDataInner`
+### Fixed
+- Fixed `flow-triggers` relationships missing the `data` property
+
 ## [13.0.0] - revision 2024-10-15
 ### Added
 - Universal Content API

README.md

@@ -1,6 +1,6 @@
 # Klaviyo Typescript SDK
 
-- SDK version: 13.0.0
+- SDK version: 14.0.0
 
 - Revision: 2024-10-15
 
@@ -52,7 +52,7 @@ This SDK is organized into the following resources:
 
 You can install this library using `npm`.
 
-`npm install klaviyo-api@13.0.0`
+`npm install klaviyo-api@14.0.0`
 
 
 ## source code
@@ -123,22 +123,16 @@ profilesApi.createProfile(profile).then(result => {
 
 ### Retry Options
 
-Constructing an API object also has optional property `RetryOptions`, this acts as a light wrapper with some different defaults around the `exponential-backoff` library
+Constructing an API object also has optional property `RetryWithExponentialBackoff`, which attempts retries on failed API calls with exponential backoff.
 
-you can override
-    - maxRetryAttempts
-    - timeMultiple
-    - startingDelay
+The default configs are:
+- retryCodes: [429, 503, 504, 524]
+- numRetries: 3
+- maxInterval: 60
 
 ```Typescript
-const retryOptions: RetryOptions = new RetryOptions({numOfAttempts: 3, timeMultiple: 5, startingDelay: 500)
-const session = new ApiKeySession("< YOUR API KEY HERE >", retryOptions)
-```
-
-if you have used exponential backoff before you can bypass the all the settings by just setting the options with a `BackoffOptions` object
-```Typescript
-const retryOptions: RetryOptions = new RetryOptions()
-retryOptions.options = { "BUILD YOUR OWN BackoffOptions object here" }
+const retryWithExponentialBackoff: RetryWithExponentialBackoff = new RetryWithExponentialBackoff({ retryCodes: [429, 503, 504, 524], numRetries: 3, maxInterval: 60})
+const session = new ApiKeySession("< YOUR API KEY HERE >", retryWithExponentialBackoff)
 ```
 
 ### Organizational Helpers
@@ -147,7 +141,7 @@ There is also an optional `Klaviyo` import that has all the Apis and Auth, if yo
 ```Typescript
 import { Klaviyo } from 'klaviyo-api'
 
-const profilesApi = new Klaviyo.ProfilesApi(new Klaviyo.Auth.ApiKeySession("< YOUR API KEY HERE >", retryOptions))
+const profilesApi = new Klaviyo.ProfilesApi(new Klaviyo.Auth.ApiKeySession("< YOUR API KEY HERE >", retry))
 ````
 
 ### Inspecting Errors
@@ -262,7 +256,7 @@ To make an API call, you need to create an `OAuthSession` instance. This session
 It takes two properties
 1. `customerIdentifier` - This is how the session is going to grab a user's authentication information and let your implementation of `TokenStorage` know where to save any update `access token`
 2. `oauthApi` - This is the instance of `OAuthApi` created above. It will dictate how the session `saves` and `retrieves` the `access tokens`
-3. `retryOptions` - OPTIONAL - the `RetryOptions` instance outlines your desired exponential backoff retry options, outlined in [Retry Options](#retry-options) above
+3. `retryWithExponentialBackoff` - OPTIONAL - the `RetryWithExponentialBackoff` instance outlines your desired exponential backoff configs, outlined in [Retry Options](#retry-options) above
 
 ```typescript
 import { OAuthSession, ProfilesApi } from 'klaviyo-api';
@@ -278,7 +272,7 @@ If you don't want to deal with any of the helpers above or don't want `klaviyo-a
 
 The `OAuthBasicSession` takes up to two parameters
 1. `accessToken` - The token is used in the API calls' authentication
-2. `retryOptions` - OPTIONAL - the `RetryOptions` instance outlines your desired exponential backoff retry options, outlined in [Retry Options](#retry-options) above
+3. `retryWithExponentialBackoff` - OPTIONAL - the `RetryWithExponentialBackoff` instance outlines your desired exponential backoff configs, outlined in [Retry Options](#retry-options) above
 
 ```typescript
 import { OAuthBasicSession } from 'klaviyo-api';
@@ -2294,18 +2288,18 @@ _______________________________
 [Create or Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/create_or_update_profile)
 
 ```typescript
-ProfilesApi.createOrUpdateProfile(profileUpsertQuery: ProfileUpsertQuery)
+ProfilesApi.createOrUpdateProfile(profileUpsertQuery: ProfileUpsertQuery, options)
 ```
 ##### Method alias:
 ```typescript
-ProfilesApi.createProfileImport(profileUpsertQuery: ProfileUpsertQuery)
+ProfilesApi.createProfileImport(profileUpsertQuery: ProfileUpsertQuery, options)
 ```
 _______________________________
 
 [Create Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/create_profile)
 
 ```typescript
-ProfilesApi.createProfile(profileCreateQuery: ProfileCreateQuery)
+ProfilesApi.createProfile(profileCreateQuery: ProfileCreateQuery, options)
 ```
 _______________________________
 
@@ -2552,7 +2546,7 @@ _______________________________
 [Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/update_profile)
 
 ```typescript
-ProfilesApi.updateProfile(id: string, profilePartialUpdateQuery: ProfilePartialUpdateQuery)
+ProfilesApi.updateProfile(id: string, profilePartialUpdateQuery: ProfilePartialUpdateQuery, options)
 ```
 _______________________________
 ## ReportingApi

api/accountsApi.ts

@@ -12,7 +12,6 @@
 
 const axios = require('axios');
 import {AxiosRequestConfig, AxiosResponse} from "axios";
-import { backOff, BackoffOptions } from 'exponential-backoff';
 import FormData from 'form-data'
 
 /* tslint:disable:no-unused-locals */
@@ -22,7 +21,7 @@ import { GetAccounts4XXResponse } from '../model/getAccounts4XXResponse';
 
 import { ObjectSerializer } from '../model/models';
 
-import {RequestFile, queryParamPreProcessor, RetryOptions, Session} from './apis';
+import {RequestFile, queryParamPreProcessor, RetryWithExponentialBackoff, Session} from './apis';
 
 let defaultBasePath = 'https://a.klaviyo.com';
 
@@ -33,7 +32,6 @@ let defaultBasePath = 'https://a.klaviyo.com';
 
 export class AccountsApi {
 
-    protected backoffOptions: BackoffOptions = new RetryOptions().options
     session: Session
 
     protected _basePath = defaultBasePath;
@@ -106,7 +104,7 @@ export class AccountsApi {
 
         const request = async (config: AxiosRequestConfig, retried = false): Promise<{ response: AxiosResponse; body: GetAccountResponse;  }> => {
             try {
-                const axiosResponse = await axios(config)
+                const axiosResponse = await this.session.requestWithRetry(config)
                 let body;
                 body = ObjectSerializer.deserialize(axiosResponse.data, "GetAccountResponse");
                 return ({response: axiosResponse, body: body});
@@ -119,10 +117,7 @@ export class AccountsApi {
             }
         }
 
-        return backOff<{ response: AxiosResponse; body: GetAccountResponse;  }>(
-            () => {return request(config)},
-            this.session.getRetryOptions()
-        );
+        return request(config)
     }
     /**
      * 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`
@@ -160,7 +155,7 @@ export class AccountsApi {
 
         const request = async (config: AxiosRequestConfig, retried = false): Promise<{ response: AxiosResponse; body: GetAccountResponseCollection;  }> => {
             try {
-                const axiosResponse = await axios(config)
+                const axiosResponse = await this.session.requestWithRetry(config)
                 let body;
                 body = ObjectSerializer.deserialize(axiosResponse.data, "GetAccountResponseCollection");
                 return ({response: axiosResponse, body: body});
@@ -173,9 +168,6 @@ export class AccountsApi {
             }
         }
 
-        return backOff<{ response: AxiosResponse; body: GetAccountResponseCollection;  }>(
-            () => {return request(config)},
-            this.session.getRetryOptions()
-        );
+        return request(config)
     }
 }