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

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
• CreateSegment   POST /apps/{app_id}/segments
• DeleteSegment   DELETE /apps/{app_id}/segments/{segment_id}
• 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

• CreateSegments → CreateSegment (endpoint and method signature updated)
• DeleteSegments → DeleteSegment (endpoint and method signature updated)

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
  • Resolves #25
• GenericSuccessBoolResponse
• GetNotificationHistoryRequestBody
• GetSegmentsSuccessResponse
• LanguageStringMap
• RateLimitError
• SegmentData
• Subscription
• SubscriptionBody
• SubscriptionNotificationTarget
• UserIdentityBody
• WebButton

Modified Models

• CreateSegments → CreateSegment (model and docs reference updated)
• DeleteSegments → DeleteSegment (model and docs reference updated)
• PropertiesBody (added)
• PropertiesDeltas (added)
• PropertiesObject (added)
• Segment (added SegmentData reference)
• Notification (updated fields)
• NotificationAllOf (updated fields)
• NotificationHistorySuccessResponse (updated fields)
• PlatformDeliveryData (updated fields)
• PlatformDeliveryDataEmailAllOf (updated fields)
• PlatformDeliveryDataSmsAllOf (updated fields)
• TransferSubscriptionRequestBody (updated fields)
• UpdateLiveActivityRequest (updated fields)
• UpdateLiveActivitySuccessResponse (updated fields)
• UpdateUserRequest (updated fields)
• User (updated fields)

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

2.2.1

Fixes

• set notification_type to be type int, instead of decimal, on SubscriptionObject

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

Fixes

• Add authMethod for DeleteUser
• Set base URL to https://api.onesignal.com/

Release 2.0.2

Added 400, 429 to all responses
Added 409 Subscription Limit Exceeded error response
Other minor changes

User Model update

Added User Model name space.

1.0.1 Release

Release Notes

Package OneSignalApi 1.0.1 has been created and published

Download the nuget package from nuget.org using OneSignalApi in the search bar.

• Created explicit model declarations rather than relying on auto-generated InlineResponseXXX models. This ensures compatibility across API code generations / releases.
• Added Name property to Notification model, which is can be used to identify your campaign the notification is sent under.
• [Fix] Updated OS-Usage-Data telemetry header set on every request to properly identify the client to OneSignal
• [Fix] Removed default setting of IsIos to true when creating a notification. This limited notifications to be sent to only iOS devices as the default. The new defaults will not specify a device type filter when sending a notification.

1.0.0 Release

Release Notes

Package OneSignalApi 1.0.0 has been created and published

Download the nuget package from nuget.org using OneSignalApi in the search bar.

• [Fix] Changed Player.AmountSpent from string to decimal

1.0.0-beta1 Release

Release Notes

Package OneSignalApi 1.0.0-beta1 has been created and published

Download the nuget package from nuget.org using OneSignalApi in the search bar.

• README contains instructions for integrating into your backend codebase