Skip to content

Add v5.0.0-beta1 package updates#22

Merged
sherwinski merged 1 commit intomainfrom
user-api-updates
May 23, 2025
Merged

Add v5.0.0-beta1 package updates#22
sherwinski merged 1 commit intomainfrom
user-api-updates

Conversation

@onesignal-deploy
Copy link
Collaborator

@onesignal-deploy onesignal-deploy commented May 5, 2025

User Model beta release

⚠️ This release includes breaking changes. Please test before using in production.

Changes

API Endpoints

Added Endpoints

  • PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity (create_alias)
  • PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity (create_alias_by_subscription)
  • POST /players/csv_export?app_id={app_id} (export_subscriptions)
  • GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity (get_aliases)
  • GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity (get_aliases_by_subscription)
  • GET /apps/{app_id}/segments (get_segments)
  • GET /apps/{app_id}/users/by/{alias_label}/{alias_id} (get_user)
  • POST /apps/{app_id}/notifications/{notification_id}/unsubscribe (unsubscribe_email_with_token)

Modified Endpoints

  • POST /apps/{app_id}/segments (create_segments → create_segment)
  • DELETE /apps/{app_id}/segments/{segment_id} (delete_segments → delete_segment)

Removed Endpoints

  • POST /apps/{app_id}/live_activities/{activity_id}/token (begin_live_activity)
  • POST /players (create_player)
  • DELETE /players/{player_id} (delete_player)
  • DELETE /apps/{app_id}/segments/{segment_id} (delete_segments; replaced by delete_segment)
  • DELETE /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} (end_live_activity)
  • POST /players/csv_export?app_id={app_id} (export_players; replaced by export_subscriptions)
  • GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity (fetch_aliases; replaced by get_aliases_by_subscription)
  • GET /apps/{app_id}/users/by/{alias_label}/{alias_id} (fetch_user; replaced by get_user)
  • GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity (fetch_user_identity; replaced by get_aliases)
  • GET /apps/{app_id}/subscriptions/{subscription_id}/iams (get_eligible_iams)
  • GET /players/{player_id} (get_player)
  • GET /players (get_players)
  • PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity (identify_user_by_alias; replaced by create_alias)
  • PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity (identify_user_by_subscription_id; replaced by create_alias_by_subscription)
  • PUT /players/{player_id} (update_player)
  • PUT /apps/{app_id}/users/{external_user_id} (update_player_tags)

Models

Added Models

  • ExportSubscriptionsRequestBody
  • ExportSubscriptionsSuccessResponse
  • FilterExpression
  • GenericSuccessBoolResponse
  • GetNotificationHistoryRequestBody
  • GetSegmentsSuccessResponse
  • LanguageStringMap
  • PropertiesBody
  • RateLimitError
  • SegmentData
  • Subscription
  • SubscriptionBody
  • SubscriptionNotificationTarget
  • UserIdentityBody
  • WebButton

Modified Models

  • RateLimiterErrorRateLimitError (renamed)
  • FilterExpressionsFilterExpression (replaced/renamed)
  • SubscriptionObjectSubscription (replaced/renamed)

Removed Models

  • BeginLiveActivityRequest
  • CancelNotificationSuccessResponse
  • CreatePlayerSuccessResponse
  • CreateSubscriptionRequestBody
  • DeletePlayerNotFoundResponse
  • DeletePlayerSuccessResponse
  • DeleteSegmentNotFoundResponse
  • DeleteSegmentSuccessResponse
  • ExportPlayersRequestBody
  • ExportPlayersSuccessResponse
  • FilterExpressions (replaced by FilterExpression)
  • GenericErrorErrorsInner
  • GetNotificationRequestBody
  • InlineResponse200
  • InlineResponse2003
  • InlineResponse201
  • InlineResponse202
  • InvalidIdentifierError
  • Notification200Errors
  • Player
  • PlayerNotificationTarget
  • PlayerNotificationTargetIncludeAliases
  • PlayerSlice
  • RateLimiterError (replaced by RateLimitError)
  • StringMap
  • SubscriptionObject (replaced by Subscription)
  • UpdatePlayerSuccessResponse
  • UpdatePlayerTagsRequestBody
  • UpdatePlayerTagsSuccessResponse
  • UpdateSubscriptionRequestBody
  • UserIdentityRequestBody
  • UserIdentityResponse
  • UserSubscriptionOptions

@sherwinski sherwinski merged commit 46bbfa3 into main May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants