braze-community / braze-node Goto Github PK

https://www.braze.com/docs/api/endpoints/user_data/post_user_track/

Problem

Hey, thanks for your work on this library - it's been super helpful!

I noticed that both apple_push and android_push are typed as objects in the MessageObject interface.

It would be cool if we can get full type support for both of these objects as demonstrated here:

• Apple object
• Android object

Suggested Solution

I'm happy to contribute and raise a PR for this but just wanted to raise an issue first in case it's on your radar or working on it

Expected Behavior

PurchaseObject.app_id should be optional

https://www.braze.com/docs/api/objects_filters/purchase_object/

Actual Behavior

PurchaseObject.app_id is required, therefore not letting send track user purchase without app_id

Steps to Reproduce

interface PurchaseObject {
    external_id?: string;
    user_alias?: UserAlias;
    braze_id?: string;
    app_id: string;
    product_id: string;
    currency: string;
    price: number;
    quantity?: number;
    time: string;
    properties?: Properties;
    _update_existing_only?: boolean;
}

Reproducible Demo

Can just change app_id to optional:

interface PurchaseObject {
    external_id?: string;
    user_alias?: UserAlias;
    braze_id?: string;
    app_id?: string;
    product_id: string;
    currency: string;
    price: number;
    quantity?: number;
    time: string;
    properties?: Properties;
    _update_existing_only?: boolean;
}

Environment

• Version: 2.7.0
• Platform:
• Browser:
• OS:

Keywords

trackUserObject, PurchaseObject, app_id

The typing on this line states errors is an object (or undefined).
https://github.com/remarkablemark/braze-api/blob/a2788803c503bd88010f3020adcf0b67dd61c587/src/users/track.ts#L34

It seems from my testing to in fact be an array of objects. This matches up with the API Documentation
https://www.braze.com/docs/api/endpoints/user_data/post_user_track/#successful-message-with-non-fatal-errors