braze-api - npm Package Compare versions

Comparing version 1.5.0 to 1.6.0

lib/Braze.d.ts

@@ -62,2 +62,5 @@ import * as campaigns from './campaigns';
         };
+        delete: (body: users.UsersDeleteObject) => Promise<{
+            deleted: number;
+        }>;
         identify: (body: users.UsersIdentifyObject) => Promise<{
@@ -64,0 +67,0 @@ [x: string]: any;

lib/Braze.js

@@ -33,2 +33,3 @@ "use strict";
             },
+            delete: (body) => users._delete(this.apiUrl, this.apiKey, body),
             identify: (body) => users.identify(this.apiUrl, this.apiKey, body),
@@ -35,0 +36,0 @@ track: (body, bulk) => users.track(this.apiUrl, this.apiKey, body, bulk),

lib/users/index.d.ts

 export * as alias from './alias';
+export * from './delete';
 export * from './identify';
@@ -3,0 +4,0 @@ export * from './track';

lib/users/index.js

@@ -19,2 +19,3 @@ "use strict";
 exports.alias = require("./alias");
+__exportStar(require("./delete"), exports);
 __exportStar(require("./identify"), exports);
@@ -21,0 +22,0 @@ __exportStar(require("./track"), exports);

lib/users/types.d.ts

@@ -13,3 +13,3 @@ import type { Properties, UserAlias } from '../common/types';
 /**
- * Request body for user track.
+ * Request body for user identify.
  *
@@ -25,2 +25,12 @@ * {@link https://www.braze.com/docs/api/endpoints/user_data/post_user_identify/#request-body}
 /**
+ * Request body for user delete.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/user_data/post_user_delete/#request-body}
+ */
+export interface UsersDeleteObject {
+    external_ids?: string[];
+    user_aliases?: UserAlias[];
+    braze_ids?: string[];
+}
+/**
  * User attributes object specification.
@@ -27,0 +37,0 @@ *

package.json

 {
   "name": "braze-api",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Track users, send messages, export data, and more with Braze API.",
@@ -5,0 +5,0 @@ "author": "Mark <[e-mail]>",

README.md

@@ -98,3 +98,3 @@ # braze-api
 - [x] /users/alias/new
-- [ ] /users/delete
+- [x] /users/delete
 - [ ] /users/export/global_control_group
@@ -101,0 +101,0 @@ - [ ] /users/export/ids

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

64110

increased by4.75%

Number of package files

107

increased by3.88%

Lines of code

978

increased by6.3%

No dependency changes