@plunk/node - npm Package Compare versions

Comparing version 2.1.0 to 3.0.0

dist/lib/Plunk.d.ts

@@ -16,2 +16,3 @@ import { PublishParams } from "../types/events";
          * @param {Object=} event.data - The user data associated with this event
+         * @param {boolean=true} event.subscribed - Whether the user is subscribed to marketing emails
          */
@@ -32,3 +33,2 @@ track: (event: PublishParams) => Promise<{
          * @param {string=html} body.type - The type of email you want to send
-         * @param {boolean=false} body.withUnsubscribe - Whether to include an unsubscribe link
          * @param {boolean=false} body.subscribed - Whether the user is subscribed to marketing emails
@@ -35,0 +35,0 @@ */

dist/lib/Plunk.js

@@ -19,2 +19,3 @@ "use strict";
              * @param {Object=} event.data - The user data associated with this event
+             * @param {boolean=true} event.subscribed - Whether the user is subscribed to marketing emails
              */
@@ -39,3 +40,2 @@ track: (event) => tslib_1.__awaiter(this, void 0, void 0, function* () {
              * @param {string=html} body.type - The type of email you want to send
-             * @param {boolean=false} body.withUnsubscribe - Whether to include an unsubscribe link
              * @param {boolean=false} body.subscribed - Whether the user is subscribed to marketing emails
@@ -42,0 +42,0 @@ */

dist/types/emails.d.ts

@@ -8,4 +8,3 @@ export interface SendParams {
     name?: string;
-    withUnsubscribe?: boolean;
     subscribed?: boolean;
 }

dist/types/events.d.ts

 export interface PublishParams {
     event: string;
     email: string;
+    subscribed?: boolean;
     data?: {
@@ -5,0 +6,0 @@ [p: string]: string | {

package.json

 {
   "name": "@plunk/node",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Official Node.js library for useplunk.com",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -39,2 +39,3 @@ # Plunk Node.js
 - `email`: The email address of the user to publish the event to
+- `subscribed` [Optional]: Whether to the contact is subscribed to marketing emails, defaults to `true`
 - `data` [Optional]: An object containing the data to attach to the user
@@ -62,3 +63,3 @@
 - `name` [Optional]: The name of the sender
-- `withUnsubscribe` [Optional]: Whether to include an unsubscribe link hosted by Plunk in the email
+- `subscribed` [Optional]: Whether to the contact is subscribed to marketing emails, defaults to `false`
 
@@ -65,0 +66,0 @@ ```ts

No alert changes

Improved metrics

Total package byte prevSize

10010

increased by1.19%

Number of lines in readme file

70

increased by1.45%

No dependency changes