User Model beta release
Changes
Auth Updates
⚠️ Replaceaccess_token
onOneSignal.configure
withrest_api_key
⚠️ Replaceuser_auth_key
onOneSignal.configure
withorganization_api_key
API Endpoints
Added Endpoints
create_alias
(PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
)create_alias_by_subscription
(PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity
)create_segment
(POST /apps/{app_id}/segments
)export_subscriptions
(POST /players/csv_export?app_id={app_id}
)get_aliases
(GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
)get_aliases_by_subscription
(GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
)get_segments
(GET /apps/{app_id}/segments
)get_user
(GET /apps/{app_id}/users/by/{alias_label}/{alias_id}
)unsubscribe_email_with_token
(POST /apps/{app_id}/notifications/{notification_id}/unsubscribe
)
Modified Endpoints
cancel_notification
(DELETE /notifications/{notification_id}
) — Updated description to "Stop a scheduled or currently outgoing notification"create_app
(POST /apps
)create_notification
(POST /notifications
)create_subscription
(POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions
)create_user
(POST /apps/{app_id}/users
)delete_alias
(DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}
)delete_segment
(DELETE /apps/{app_id}/segments/{segment_id}
)delete_subscription
(DELETE /apps/{app_id}/subscriptions/{subscription_id}
)delete_user
(DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}
)export_events
(POST /notifications/{notification_id}/export_events?app_id={app_id}
)get_app
(GET /apps/{app_id}
)get_apps
(GET /apps
)get_notification
(GET /notifications/{notification_id}
)get_notification_history
(POST /notifications/{notification_id}/history
)get_notifications
(GET /notifications
)get_outcomes
(GET /apps/{app_id}/outcomes
)transfer_subscription
(PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner
)update_app
(PUT /apps/{app_id}
)update_live_activity
(POST /apps/{app_id}/live_activities/{activity_id}/notifications
)update_subscription
(PATCH /apps/{app_id}/subscriptions/{subscription_id}
)update_user
(PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}
)
Removed Endpoints
begin_live_activity
(POST /apps/{app_id}/live_activities/{activity_id}/token
)create_player
(POST /players
)create_segments
(POST /apps/{app_id}/segments
)delete_player
(DELETE /players/{player_id}
)delete_segments
(DELETE /apps/{app_id}/segments/{segment_id}
)end_live_activity
(DELETE /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id}
)export_players
(POST /players/csv_export?app_id={app_id}
)fetch_aliases
(GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
)fetch_user
(GET /apps/{app_id}/users/by/{alias_label}/{alias_id}
)fetch_user_identity
(GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
)get_eligible_iams
(GET /apps/{app_id}/subscriptions/{subscription_id}/iams
)get_player
(GET /players/{player_id}
)get_players
(GET /players
)identify_user_by_alias
(PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
)identify_user_by_subscription_id
(PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity
)update_player
(PUT /players/{player_id}
)update_player_tags
(PUT /apps/{app_id}/users/{external_user_id}
)
Models
Added Models
ExportSubscriptionsRequestBody
ExportSubscriptionsSuccessResponse
FilterExpression
GenericSuccessBoolResponse
GetNotificationHistoryRequestBody
GetSegmentsSuccessResponse
LanguageStringMap
PropertiesBody
RateLimitError
SegmentData
Subscription
SubscriptionBody
SubscriptionNotificationTarget
UserIdentityBody
WebButton
Modified Models
CancelNotificationSuccessResponse
(removed, but endpoint updated)CreateSegmentSuccessResponse
Notification
NotificationAllOf
NotificationHistorySuccessResponse
NotificationSlice
PlatformDeliveryData
PlatformDeliveryDataEmailAllOf
PlatformDeliveryDataSmsAllOf
PropertiesDeltas
PropertiesObject
Purchase
Segment
SegmentNotificationTarget
TransferSubscriptionRequestBody
UpdateLiveActivityRequest
UpdateLiveActivitySuccessResponse
UpdateUserRequest
User
Removed Models
BeginLiveActivityRequest
CancelNotificationSuccessResponse
CreatePlayerSuccessResponse
CreateSubscriptionRequestBody
DeletePlayerNotFoundResponse
DeletePlayerSuccessResponse
DeleteSegmentNotFoundResponse
DeleteSegmentSuccessResponse
ExportPlayersRequestBody
ExportPlayersSuccessResponse
FilterExpressions
GenericErrorErrorsInner
GetNotificationRequestBody
InlineResponse200
InlineResponse2003
InlineResponse201
InlineResponse202
InvalidIdentifierError
Notification200Errors
Player
PlayerNotificationTarget
PlayerNotificationTargetIncludeAliases
PlayerSlice
RateLimiterError
StringMap
SubscriptionObject
UpdatePlayerSuccessResponse
UpdatePlayerTagsRequestBody
UpdatePlayerTagsSuccessResponse
UpdateSubscriptionRequestBody
UserIdentityRequestBody
UserIdentityResponse
UserSubscriptionOptions