5.3.0-beta1

Features

• adds support for the Custom Events endpoint
• adds support for the Start Live Activity endpoint
• adds support for the Template endpoints
• adds support for the Update Subscription by token endpoint
• adds support for the Authentication endpoints

5.2.1-beta1

Features

• add canceled boolean to NotificationWithMeta schema

5.2.0-beta1

Features

• add disable_email_click_tracking Notification API parameter

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 HttpBearerAuth with restApiKey
• ⚠️ Replace user_key on HttpBearerAuth with organization_api_key

API Endpoints

Added Endpoints

• createAlias: PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
• createAliasBySubscription: PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity
• exportSubscriptions: POST /players/csv_export?app_id={app_id}
• getAliases: GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
• getAliasesBySubscription: GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
• getSegments: GET /apps/{app_id}/segments
• getUser: GET /apps/{app_id}/users/by/{alias_label}/{alias_id}
• unsubscribeEmailWithToken: POST /apps/{app_id}/notifications/{notification_id}/unsubscribe

Modified Endpoints

• createSegment (was createSegments): POST /apps/{app_id}/segments | Create Segment (was Create Segments)
• deleteSegment (was deleteSegments): DELETE /apps/{app_id}/segments/{segment_id} | Delete Segment (was Delete Segments)

Removed Endpoints

• beginLiveActivity: POST /apps/{app_id}/live_activities/{activity_id}/token
• createPlayer: POST /players
• deletePlayer: DELETE /players/{player_id}
• deleteSegments: DELETE /apps/{app_id}/segments/{segment_id}
• endLiveActivity: DELETE /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id}
• exportPlayers: POST /players/csv_export?app_id={app_id}
• fetchAliases: GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
• fetchUser: GET /apps/{app_id}/users/by/{alias_label}/{alias_id}
• fetchUserIdentity: GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
• getEligibleIams: GET /apps/{app_id}/subscriptions/{subscription_id}/iams
• getPlayer: GET /players/{player_id}
• getPlayers: GET /players
• identifyUserByAlias: PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
• identifyUserBySubscriptionId: PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity
• updatePlayer: PUT /players/{player_id}
• updatePlayerTags: 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

• createSegment (was createSegments)

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

1.4.1

Fixes

• set notification_type to be type Integer, instead of BigDecimal, on SubscriptionObject

1.4.0

Features

• deprecate external_id in favor of idempotency_key as basenotification field

Fixes

• favor Key auth prefix over Bearer

1.3.0

Features

• Add authMethod for deleteUserCall

Fixes

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