braze-api - npm Package Compare versions

Comparing version 1.11.0 to 1.12.0

lib/Braze.d.ts

@@ -84,3 +84,4 @@ import * as campaigns from './campaigns';
         export: {
-            ids: (body: users.export.UsersExportsIdsObject) => Promise<users.export.UsersExportsIdsResponse>;
+            ids: (body: users.export.UsersExportIdsObject) => Promise<users.export.UsersExportIdsResponse>;
+            segment: (body: users.export.UsersExportSegmentObject) => Promise<users.export.UsersExportSegmentResponse>;
         };
@@ -87,0 +88,0 @@ external_ids: {

lib/Braze.js

@@ -48,2 +48,3 @@ "use strict";
                 ids: (body) => users.export.ids(this.apiUrl, this.apiKey, body),
+                segment: (body) => users.export.segment(this.apiUrl, this.apiKey, body),
             },
@@ -50,0 +51,0 @@ external_ids: {

lib/users/export/ids.d.ts

@@ -1,2 +0,2 @@
-import type { UsersExportsIdsObject, UsersExportsIdsResponse } from './types';
+import type { UsersExportIdsObject, UsersExportIdsResponse } from './types';
 /**
@@ -14,3 +14,3 @@ * Users by identifier endpoint.
  */
-export declare function ids(apiUrl: string, apiKey: string, body: UsersExportsIdsObject): Promise<UsersExportsIdsResponse>;
+export declare function ids(apiUrl: string, apiKey: string, body: UsersExportIdsObject): Promise<UsersExportIdsResponse>;
 //# sourceMappingURL=ids.d.ts.map

lib/users/export/index.d.ts

 export * from './ids';
+export * from './segment';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

lib/users/export/index.js

@@ -18,3 +18,4 @@ "use strict";
 __exportStar(require("./ids"), exports);
+__exportStar(require("./segment"), exports);
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

lib/users/export/types.d.ts

@@ -7,3 +7,3 @@ import type { UserAlias } from '../../common/types';
  */
-export interface UsersExportsIdsObject {
+export interface UsersExportIdsObject {
     external_ids?: string[];
@@ -22,3 +22,3 @@ user_aliases?: UserAlias[];
  */
-export interface UsersExportsIdsResponse {
+export interface UsersExportIdsResponse {
     message: string;
@@ -28,2 +28,23 @@ users: Partial<UserExportObject>[];
 }
+/**
+ * Request body for users by segment endpoint.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/export/user_data/post_users_segment/#request-body}
+ */
+export interface UsersExportSegmentObject {
+    segment_id: string;
+    callback_endpoint?: string;
+    fields_to_export: FieldsToExport[];
+    output_format?: 'zip' | 'gzip';
+}
+/**
+ * Response body for users by segment endpoint.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/export/user_data/post_users_segment/#response}
+ */
+export interface UsersExportSegmentResponse {
+    message: string;
+    object_prefix: string;
+    url?: string;
+}
 interface UserExportObject {
@@ -45,3 +66,3 @@ created_at: string;
     last_coordinates: [number, number];
-    gender: 'M' | 'F';
+    gender: 'M' | 'F' | 'O' | 'N' | 'P' | null;
     total_revenue: number;
@@ -82,7 +103,7 @@ attributed_campaign: string;
     os: string;
-    carrier: string | null;
+    carrier?: string | null;
     device_id?: string;
     idfv?: string;
-    idfa?: string;
-    google_ad_id?: string;
+    idfa?: string | null;
+    google_ad_id?: string | null;
     roku_ad_id?: string;
@@ -142,5 +163,6 @@ windows_ad_id?: string;
  * {@link https://www.braze.com/docs/api/endpoints/export/user_data/post_users_identifier/#fields-to-export}
+ * {@link https://www.braze.com/docs/api/endpoints/export/user_data/post_users_segment/#fields-to-export}
  */
-declare type FieldsToExport = 'apps' | 'attributed_campaign' | 'attributed_campaign' | 'attributed_adgroup' | 'attributed_ad' | 'braze_id' | 'country' | 'created_at' | 'custom_attributes' | 'custom_events' | 'devices' | 'dob' | 'email' | 'external_id' | 'first_name' | 'gender' | 'home_city' | 'language' | 'last_coordinates' | 'last_name' | 'phone' | 'purchases' | 'random_bucket' | 'time_zone' | 'total_revenue' | 'uninstalled_at' | 'user_aliases';
+declare type FieldsToExport = 'apps' | 'attributed_campaign' | 'attributed_source' | 'attributed_adgroup' | 'attributed_ad' | 'braze_id' | 'country' | 'created_at' | 'custom_attributes' | 'custom_events' | 'devices' | 'dob' | 'email' | 'external_id' | 'first_name' | 'gender' | 'home_city' | 'language' | 'last_coordinates' | 'last_name' | 'phone' | 'purchases' | 'random_bucket' | 'time_zone' | 'total_revenue' | 'uninstalled_at' | 'user_aliases';
 export {};
 //# sourceMappingURL=types.d.ts.map

package.json

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

README.md

@@ -101,3 +101,3 @@ # braze-api
 - [x] /users/export/ids
-- [ ] /users/export/segment
+- [x] /users/export/segment
 - [x] /users/external_ids/rename
@@ -104,0 +104,0 @@ - [x] /users/external_ids/remove

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

101545

increased by3.8%

Number of package files

171

increased by2.4%

Lines of code

1620

increased by4.25%

No dependency changes