braze-api - npm Package Compare versions

Comparing version 1.25.0 to 1.26.0

lib/Braze.d.ts

@@ -102,2 +102,6 @@ import * as campaigns from './campaigns';
         status: {
+            get: (body: subscription.status.SubscriptionStatusGetObject) => Promise<{
+                status: Record<string, "Subscribed" | "Unsubscribed" | "Unknown">;
+                message: string;
+            }>;
             set: (body: subscription.status.SubscriptionStatusSetObject) => Promise<{
@@ -104,0 +108,0 @@ message: string;

lib/Braze.js

@@ -54,2 +54,3 @@ "use strict";
             status: {
+                get: (body) => subscription.status.get(this.apiUrl, this.apiKey, body),
                 set: (body) => subscription.status.set(this.apiUrl, this.apiKey, body),
@@ -56,0 +57,0 @@ },

lib/subscription/status/index.d.ts

@@ -0,3 +1,4 @@
+export * from './get';
 export * from './set';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

lib/subscription/status/index.js

@@ -17,4 +17,5 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./get"), exports);
 __exportStar(require("./set"), exports);
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

lib/subscription/status/types.d.ts

@@ -6,12 +6,23 @@ /**
  */
-export declare type SubscriptionStatusSetObject = SubscriptionStatusWithPhone | SubscriptionStatusWithEmail;
-interface SubscriptionStatus {
+export declare type SubscriptionStatusSetObject = SubscriptionStatusSetWithPhone | SubscriptionStatusSetWithEmail;
+/**
+ * Request body for get users’ subscription group status.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/subscription_groups/get_list_user_subscription_group_status/#request-parameters}
+ */
+export declare type SubscriptionStatusGetObject = {
     subscription_group_id: string;
+    external_id?: string | string[];
+    email?: string | string[];
+    phone?: string | string[];
+};
+interface SubscriptionStatusSet {
+    subscription_group_id: string;
     subscription_state: 'unsubscribed' | 'subscribed';
     external_id: string[];
 }
-interface SubscriptionStatusWithPhone extends SubscriptionStatus {
+interface SubscriptionStatusSetWithPhone extends SubscriptionStatusSet {
     phone: string[];
 }
-interface SubscriptionStatusWithEmail extends SubscriptionStatus {
+interface SubscriptionStatusSetWithEmail extends SubscriptionStatusSet {
     email: string[];
@@ -18,0 +29,0 @@ }

package.json

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

README.md

@@ -132,3 +132,3 @@ # braze-api
 - [x] /v2/subscription/status/set
-- [ ] /subscription/status/get
+- [x] /subscription/status/get
 - [ ] /subscription/user/status
@@ -135,0 +135,0 @@

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

165085

increased by2.83%

Number of package files

283

increased by1.43%

Lines of code

2678

increased by2.88%

No dependency changes