braze-api - npm Package Compare versions

Comparing version 1.12.0 to 1.13.0

lib/Braze.d.ts

@@ -84,2 +84,3 @@ import * as campaigns from './campaigns';
         export: {
+            global_control_group: (body: users.export.UsersExportGlobalControlGroupObject) => Promise<users.export.UsersExportGlobalControlGroupResponse>;
             ids: (body: users.export.UsersExportIdsObject) => Promise<users.export.UsersExportIdsResponse>;
@@ -86,0 +87,0 @@ segment: (body: users.export.UsersExportSegmentObject) => Promise<users.export.UsersExportSegmentResponse>;

lib/Braze.js

@@ -47,2 +47,3 @@ "use strict";
             export: {
+                global_control_group: (body) => users.export.global_control_group(this.apiUrl, this.apiKey, body),
                 ids: (body) => users.export.ids(this.apiUrl, this.apiKey, body),
@@ -49,0 +50,0 @@ segment: (body) => users.export.segment(this.apiUrl, this.apiKey, body),

lib/users/export/index.d.ts

@@ -0,1 +1,2 @@
+export * from './global_control_group';
 export * from './ids';
@@ -2,0 +3,0 @@ export * from './segment';

lib/users/export/index.js

@@ -17,2 +17,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./global_control_group"), exports);
 __exportStar(require("./ids"), exports);
@@ -19,0 +20,0 @@ __exportStar(require("./segment"), exports);

lib/users/export/types.d.ts

 import type { UserAlias } from '../../common/types';
 /**
+ * Request body for users by Global Control Group.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/export/user_data/post_users_global_control_group/#request-body}
+ */
+export interface UsersExportGlobalControlGroupObject {
+    callback_endpoint?: string;
+    fields_to_export: FieldsToExport[];
+    output_format?: 'zip' | 'gzip';
+}
+/**
+ * Response body for users by Global Control Group.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/export/user_data/post_users_global_control_group/#response}
+ */
+export interface UsersExportGlobalControlGroupResponse {
+    message: 'success' | string;
+    object_prefix: string;
+    url?: string;
+}
+/**
  * Request body for users by identifier endpoint.
@@ -22,3 +42,3 @@ *
 export interface UsersExportIdsResponse {
-    message: string;
+    message: 'success' | string;
     users: Partial<UserExportObject>[];
@@ -44,3 +64,3 @@ invalid_user_ids?: string[];
 export interface UsersExportSegmentResponse {
-    message: string;
+    message: 'success' | string;
     object_prefix: string;
@@ -47,0 +67,0 @@ url?: string;

package.json

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

README.md

@@ -99,3 +99,3 @@ # braze-api
 - [x] /users/delete
-- [ ] /users/export/global_control_group
+- [x] /users/export/global_control_group
 - [x] /users/export/ids
@@ -102,0 +102,0 @@ - [x] /users/export/segment

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

105503

increased by3.9%

Number of package files

175

increased by2.34%

Lines of code

1684

increased by3.95%

No dependency changes