[Bug]: Can't create notifications targeting a list of external ids

[remiremi]

What happened?

The REST API makes it possible to send notifications to a list of users given their external ids: https://documentation.onesignal.com/reference/create-notification#platform-to-deliver-to

However the sdk doesn't seem to make it possible, because the field include_aliases expects an object of type PlayerNotificationTargetIncludeAliases, which definition doesn't make it possible to define the external_id field.

This is what the serialized JSON for include_aliases should look like according to REST API documentation

  "include_aliases": {
    "external_id": ["external_user_id_on_push_email_sms"]
  },

Steps to reproduce?

Install latest version of sdk.

To try and make the call with the SDK, run:

    const notification = new OneSignal.Notification()
    notification.app_id = this.appId
    notification.include_aliases = new OneSignal.PlayerNotificationTargetIncludeAliases();
    notification.include_aliases.external_id = ["my-id-1", "my-id-2"]

Typescript will complain that

"Property 'external_id' does not exist on type 'PlayerNotificationTargetIncludeAliases'.ts(2339)"

What did you expect to happen?

I expect the SDK to have the correct type definition of PlayerNotificationTargetIncludeAliases so that the API call can be made with the correct parameters.

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[alexrabin]

I'm getting this error as well. The typescript types are wrong

[iAmWillShepherd]

@remiremi @alexrabin could you share which version of the SDK you're using?

[alexrabin]

@remiremi @alexrabin could you share which version of the SDK you're using?

I am using 2.0.1-beta2

[iAmWillShepherd]

@remiremi

I am using 2.0.1-beta2

I suspected that, but I just wanted to confirm. Thanks for the prompt reply 🙏🏽

[iAmWillShepherd]

I'm working on reproducing this now in my sample project. Once I reproduce there, I can start to build additional context to understand what's going wrong and how we can fix our typings.

[alexrabin]

@iAmWillShepherd thanks for looking into this!

[iAmWillShepherd]

I reproduce this issue, and the team is aware of the problem. However, I have little insight into when a fix will be available.

╭─iamwill@kronos ~/code/@onesignalDevelopers/OneSignal-Node-Sample ‹main●› 
╰─$ ./bin/dev notification create -A 202d4f61-1ca9-42df-9d36-bb17d8613abf --name "Include EUID test" -- "Did it work"
Sending push notification... done
{
  "id": "",
  "errors": {}
}

@remiremi

notification.include_aliases.external_id = ["my-id-1", "my-id-2"]

You're 100 percent correct that this isn't possible. The only property you can access is alias_label.

Did you try including EIDs via the Notification.include_external_user_ids property?

const notification = new OneSignal.Notification()
notification.include_external_user_ids = ['id1', 'id2', 'id3']

[alexrabin]

@iAmWillShepherd Yes I am however the documentation says the attribute is deprecated:

DEPRECATED: Use include_aliases with target_channel instead.

https://documentation.onesignal.com/reference/create-notification#send-to-specific-devices

[iAmWillShepherd]

@iAmWillShepherd Yes I am however the documentation says the attribute is deprecated:

DEPRECATED: Use include_aliases with target_channel instead.

https://documentation.onesignal.com/reference/create-notification#send-to-specific-devices

They are indeed being deprecated, however, they should still be available to use until we ship an updated SDK.

[alexrabin]

@iAmWillShepherd Yes the attribute does currently work but I'd rather not use an attribute that is deprecated.

[iAmWillShepherd]

@iAmWillShepherd Yes the attribute does currently work but I'd rather not use an attribute that is deprecated.

I understand. However, the property is not deprecated yet. It's marked as Deprecating, so it's a warning that it will be deprecated in the future and subsequently not supported some time after the official deprecation takes place.

If you're OK with waiting indefinitely, we will ship an SDK that enables you to avoid using the deprecated property. My suggestion was meant to unblock you today. A fix will likely not be released at any point this week.

[alexrabin]

@iAmWillShepherd I understand. Thank you

[kpturner]

I am stuck on the same problem, but I want to include the onesignal_id alias rather than external_id.
What is the work around for that please?