Merge pull request #17 from klaviyo/v2.1.1

2.1.1 release

Author: Ian-Montgomery-Klaviyo

CHANGELOG.md

@@ -1,7 +1,19 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [2.1.0] - revision 2023-01-24
+## [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)

README.md

@@ -1,6 +1,6 @@
 # Klaviyo JavaScript SDK
 
-- SDK version: 2.1.0
+- SDK version: 2.1.1
 
 - Revision: 2023-02-22
 
@@ -60,9 +60,9 @@ ConfigWrapper("KLAVIYO PRIVATE KEY GOES HERE")
 ```
 Or if ES6 isn't your thing
 ```JavaScript
-var KaviyoSdk = require('klaviyo-api');
+var klaviyoSdk = require('klaviyo-api');
 
-KaviyoSdk.ConfigWrapper("KLAVIYO PRIVATE KEY GOES HERE")
+klaviyoSdk.ConfigWrapper("KLAVIYO PRIVATE KEY GOES HERE")
 ```
 
 To edit the exponential backoff built into the ConfigWrapper you can pass optional parameters
@@ -77,8 +77,9 @@ ConfigWrapper("KLAVIYO PRIVATE KEY GOES HERE", {
 })
 ```
 
-NOTE:
+NOTES:
 * The SDK retries on resolvable errors, namely: rate limits (common) and server errors on klaviyo (rare).
+* The first ConfigWrapper created is the default, if you want to use more than one api key see [multi-store instructions below](https://github.com/klaviyo/klaviyo-api-node#multiple-stores)
 
 ### To call the `getProfile` operation:
 
@@ -104,19 +105,19 @@ try {
     response = await Profiles.getProfile(profileId, opts)
     console.log(response);
 } catch (e) {
-    console.log(error);
+    console.log(e);
 }
 ```
 
 once again if you're not using ES6
 
 ```Javascript
-var KaviyoSdk = require('klaviyo-api');
+var KlaviyoSdk = require('klaviyo-api');
 
 var profileId = "PROFILE_ID";
 var opts = {};
 
-KaviyoSdk.Profiles.getProfile(profileId, opts)
+KlaviyoSdk.Profiles.getProfile(profileId, opts)
     .then(data => 'Do Something Here')
     .catch(error => 'An error was thrown check the HTTP code with error.status');
 ```
@@ -142,7 +143,7 @@ try {
     const status = response.status
     const headers = response.headers
 } catch (e) {
-    console.log(error);
+    console.log(e);
 }
 ```
 
@@ -182,7 +183,7 @@ Obtain the cursor value from the call you want to get the next page for, then pa
 // page cursor looks like 'WzE2NDA5OTUyMDAsICIzYzRjeXdGTndadyIsIHRydWVd'
 // next.link returns the entire url of the next call but the sdk will accept the entire link and use only the relevant cursor
 
-const response = await Profiles.getProfiles();
+const response = await Profiles.getProfiles({});
 const opts = {pageCursor: response.body.links.next}
 const response2 = await Profiles.getProfiles(opts);
 ```
@@ -256,7 +257,7 @@ const Campaigns.createCampaignClone(body)
 
 
 
-#### [Create Campaign Message Assign Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_message_assign_template)
+#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_message_assign_template)
 
 ```JavaScript
 const Campaigns.createCampaignMessageAssignTemplate(body)
@@ -1585,7 +1586,7 @@ const Templates.updateTemplate(body, id)
 
 try {
     await YOUR_CALL
-} catch e {
+} catch (e) {
     print(e.status, e.body, e.headers)
 }
 ```

dist/ApiClient.js

@@ -58,7 +58,7 @@ var ApiClient = /*#__PURE__*/function () {
      */
     this.defaultHeaders = {
       revision: "2023-02-22",
-      "User-Agent": "klaviyo-api-node/2.1.0"
+      "User-Agent": "klaviyo-api-node/2.1.1"
     };
 
     /**

dist/api/CampaignsApi.js

@@ -142,7 +142,7 @@ function CampaignsApi(apiClient) {
     };
   }());
   /**
-   * Create Campaign Message Assign Template
+   * Assign Campaign Message Template
    * Creates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`  **Scopes:** `Campaigns Write`
    * @param {<&vendorExtensions.x-jsdoc-type>} body Takes a reusable template, clones it, and assigns the non-reusable clone to the message.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}

dist/api/CatalogsApi.js

@@ -340,7 +340,7 @@ function CatalogsApi(apiClient) {
   /**
    * Delete Catalog Category
    * Delete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`  **Scopes:** `Catalogs Write`
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog category ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
    */
   _defineProperty(this, "deleteCatalogCategory", /*#__PURE__*/function () {
@@ -467,7 +467,7 @@ function CatalogsApi(apiClient) {
   /**
    * Delete Catalog Item
    * Delete a catalog item with the given item ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;  **Scopes:** &#x60;Catalogs Write&#x60;
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog item ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
    */
   _defineProperty(this, "deleteCatalogItem", /*#__PURE__*/function () {
@@ -594,7 +594,7 @@ function CatalogsApi(apiClient) {
   /**
    * Delete Catalog Variant
    * Delete a catalog item variant with the given variant ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;  **Scopes:** &#x60;Catalogs Write&#x60;
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog variant ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
    */
   _defineProperty(this, "deleteCatalogVariant", /*#__PURE__*/function () {
@@ -708,7 +708,7 @@ function CatalogsApi(apiClient) {
   /**
    * Get Catalog Category
    * Get a catalog category with the given category ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60;  **Scopes:** &#x60;Catalogs Read&#x60;
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog category ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @param {Object} opts Optional parameters
    * @param {Array.<module:model/String>} opts.fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
@@ -769,7 +769,7 @@ function CatalogsApi(apiClient) {
   /**
    * Get Catalog Category Items
    * Get all items in a category with the given category ID. Items can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Include parameters can be provided to get the following related resource data: &#x60;variants&#x60; Returns a maximum of 100 items per request.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60;  **Scopes:** &#x60;Catalogs Read&#x60;
-   * @param {<&vendorExtensions.x-jsdoc-type>} categoryId The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} categoryId The catalog category ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @param {Object} opts Optional parameters
    * @param {Array.<module:model/String>} opts.fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
    * @param {Array.<module:model/String>} opts.fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
@@ -909,7 +909,7 @@ function CatalogsApi(apiClient) {
   /**
    * Get Catalog Item
    * Get a specific catalog item with the given item ID. Include parameters can be provided to get the following related resource data: &#x60;variants&#x60;&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60;  **Scopes:** &#x60;Catalogs Read&#x60;
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog item ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @param {Object} opts Optional parameters
    * @param {Array.<module:model/String>} opts.fieldsCatalogItem For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
    * @param {Array.<module:model/String>} opts.fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
@@ -974,7 +974,7 @@ function CatalogsApi(apiClient) {
   /**
    * Get Catalog Item Categories
    * Get all catalog categories that an item with the given item ID is in. Catalog categories can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Returns a maximum of 100 categories per request.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60;  **Scopes:** &#x60;Catalogs Read&#x60;
-   * @param {<&vendorExtensions.x-jsdoc-type>} itemId The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} itemId The catalog item ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @param {Object} opts Optional parameters
    * @param {Array.<module:model/String>} opts.fieldsCatalogCategory For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
    * @param {String} opts.filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;name&#x60;: &#x60;contains&#x60;
@@ -1110,7 +1110,7 @@ function CatalogsApi(apiClient) {
   /**
    * Get Catalog Item Variants
    * Get all variants related to the given item ID. Variants can be sorted by the following fields, in ascending and descending order: &#x60;created&#x60; Returns a maximum of 100 variants per request.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60;  **Scopes:** &#x60;Catalogs Read&#x60;
-   * @param {<&vendorExtensions.x-jsdoc-type>} itemId The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} itemId The catalog item ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @param {Object} opts Optional parameters
    * @param {Array.<module:model/String>} opts.fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
    * @param {String} opts.filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;ids&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;item&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;sku&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;title&#x60;: &#x60;contains&#x60;&lt;br&gt;&#x60;published&#x60;: &#x60;equals&#x60;
@@ -1239,7 +1239,7 @@ function CatalogsApi(apiClient) {
   /**
    * Get Catalog Variant
    * Get a catalog item variant with the given variant ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;350/s&#x60;&lt;br&gt;Steady: &#x60;3500/m&#x60;  **Scopes:** &#x60;Catalogs Read&#x60;
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog variant ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @param {Object} opts Optional parameters
    * @param {Array.<module:model/String>} opts.fieldsCatalogVariant For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
@@ -2922,7 +2922,7 @@ function CatalogsApi(apiClient) {
    * Update Catalog Category
    * Update a catalog category with the given category ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;  **Scopes:** &#x60;Catalogs Write&#x60;
    * @param {<&vendorExtensions.x-jsdoc-type>} body 
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog category ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog category ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
    */
   _defineProperty(this, "updateCatalogCategory", /*#__PURE__*/function () {
@@ -3056,7 +3056,7 @@ function CatalogsApi(apiClient) {
    * Update Catalog Item
    * Update a catalog item with the given item ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;  **Scopes:** &#x60;Catalogs Write&#x60;
    * @param {<&vendorExtensions.x-jsdoc-type>} body 
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog item ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog item ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
    */
   _defineProperty(this, "updateCatalogItem", /*#__PURE__*/function () {
@@ -3190,7 +3190,7 @@ function CatalogsApi(apiClient) {
    * Update Catalog Variant
    * Update a catalog item variant with the given variant ID.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60;  **Scopes:** &#x60;Catalogs Write&#x60;
    * @param {<&vendorExtensions.x-jsdoc-type>} body 
-   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog variant ID is a compound ID (string), with format: &#x60;${integration}:::${catalog}:::${external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
+   * @param {<&vendorExtensions.x-jsdoc-type>} id The catalog variant ID is a compound ID (string), with format: &#x60;{integration}:::{catalog}:::{external_id}&#x60;. Currently, the only supported integration type is &#x60;$custom&#x60;, and the only supported catalog is &#x60;$default&#x60;.
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
    */
   _defineProperty(this, "updateCatalogVariant", /*#__PURE__*/function () {

dist/api/FlowsApi.js

@@ -814,7 +814,7 @@ function FlowsApi(apiClient) {
    * Update Flow Status
    * Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m`  **Scopes:** `Flows Write`
    * @param {<&vendorExtensions.x-jsdoc-type>} body 
-   * @param {<&vendorExtensions.x-jsdoc-type>} id 
+   * @param {<&vendorExtensions.x-jsdoc-type>} id ID of the Flow to update. Ex: XVTP5Q
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}
    */
   _defineProperty(this, "updateFlow", /*#__PURE__*/function () {