5.1.0-beta1

User Model beta release

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

Changes

Auth Updates

• ⚠️ Replace app_key on Configuration with rest_api_key
• ⚠️ Replace user_key on Configuration with organization_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
• 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
• export_subscriptions – POST /players/csv_export?app_id={app_id}
• 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

Changed Endpoints (renamed or replaced)

• create_segments → now create_segment
• delete_segments → now delete_segment
• export_players → now export_subscriptions
• fetch_aliases → now get_aliases_by_subscription
• fetch_user → now get_user

Removed Endpoints

• begin_live_activity – POST /apps/{app_id}/live_activities/{activity_id}/token
• end_live_activity – DELETE /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id}
• create_player – POST /players
• delete_player – DELETE /players/{player_id}
• 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
• LanguageStringMap
• GetSegmentsSuccessResponse
• RateLimitError
• SegmentData
• Subscription
• SubscriptionBody
• SubscriptionNotificationTarget
• UserIdentityBody
• WebButton

Removed Models

• Buttons
• CreatePlayerSuccessResponse
• DeletePlayerNotFoundResponse
• DeletePlayerSuccessResponse
• Player
• PlayerNotificationTarget
• PlayerNotificationTargetIncludeAliases
• PlayerSlice
• Players
• UpdatePlayerSuccessResponse
• UpdatePlayerTagsRequestBody
• UpdatePlayerTagsSuccessResponse

2.2.1

Fixes

• set notification_type to be type int, instead of float, on SubscriptionObject (resolves #46)

2.2.0

Features

• deprecate external_id in favor of idempotency_key as basenotification field

Fixes

• favor Key auth prefix over Bearer

2.1.0

Features

• Add authMethod for delete_user_endpoint

Fixes

• Set base URL to https://api.onesignal.com/