5.1.0-beta1

User Model beta release

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

Changes

Auth Updates

• ⚠️ Replace access_token on OneSignal.configure with rest_api_key
• ⚠️ Replace user_auth_key on OneSignal.configure 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)
• 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

2.2.1

Fixes

• set notification_type to be type Integer, instead of Float, 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

Features

• Add authMethod for delete_user_with_http_info

Fixes

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

1.0.1 Release

What's Changed

• 1.0.0 Beta 1 Release Commit by @rgomezp in #5
• Repo maintenance updates by @rgomezp in #8
• Remove CODE OF CONDUCT by @rgomezp in #9
• Update: Ruby 1.0.1 by @jmadler in #14
• Dependency Update by @jmadler in #16

New Contributors

• @rgomezp made their first contribution in #5
• @jmadler made their first contribution in #14

Full Changelog: v0.3.0...1.0.1

1.0.0 Release (Beta 1)

1.0.0 Beta 1

The Beta 1 Release of the updated OneSignal gem is here!

See README for more details.

RubyGem