Skip to content

Add v5.0.0-beta1 package updates #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2025
Merged

Add v5.0.0-beta1 package updates #24

merged 1 commit into from
May 23, 2025

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

Models

Added

  • ExportSubscriptionsSuccessResponse
  • Export_subscriptions_request_body
  • GenericSuccessBoolResponse
  • GetSegmentsSuccessResponse
  • Get_notification_history_request_body
  • PropertiesBody
  • RateLimitError
  • SubscriptionBody
  • UserIdentityBody

Removed

  • BeginLiveActivityRequest
  • CancelNotificationSuccessResponse
  • CreatePlayerSuccessResponse
  • CreateSubscriptionRequestBody
  • DeletePlayerNotFoundResponse
  • DeletePlayerSuccessResponse
  • DeleteSegmentNotFoundResponse
  • DeleteSegmentSuccessResponse
  • ExportPlayersSuccessResponse
  • Export_players_request_body
  • Get_notification_request_body
  • Inline_response_200
  • Inline_response_200_3
  • Inline_response_201
  • Inline_response_202
  • Player
  • PlayerSlice
  • RateLimiterError
  • UpdatePlayerSuccessResponse
  • UpdatePlayerTagsSuccessResponse
  • UpdateSubscriptionRequestBody
  • Update_player_tags_request_body
  • UserIdentityRequestBody
  • UserIdentityResponse

APIs

Added APIs

  • cancelNotification

    • pplx::task<std::shared_ptr<GenericSuccessBoolResponse>> cancelNotification(utility::string_t appId, utility::string_t notificationId) const = 0;
  • createAlias

    • pplx::task<std::shared_ptr<UserIdentityBody>> createAlias(utility::string_t appId, utility::string_t aliasLabel, utility::string_t aliasId, std::shared_ptr<UserIdentityBody> userIdentityBody) const = 0;
  • createAliasBySubscription

    • pplx::task<std::shared_ptr<UserIdentityBody>> createAliasBySubscription(utility::string_t appId, utility::string_t subscriptionId, std::shared_ptr<UserIdentityBody> userIdentityBody) const = 0;
  • createSegment

    • (renamed and modified from createSegments)
    • pplx::task<std::shared_ptr<CreateSegmentSuccessResponse>> createSegment(utility::string_t appId, boost::optional<std::shared_ptr<Segment>> segment) const = 0;
  • createSubscription

    • Signature changed:
      Now returns std::shared_ptr<SubscriptionBody>
      Accepts std::shared_ptr<SubscriptionBody> subscriptionBody
  • deleteAlias

    • Now returns std::shared_ptr<UserIdentityBody>
  • deleteSegment

    • (renamed and modified from deleteSegments)
    • Now returns std::shared_ptr<GenericSuccessBoolResponse>
  • exportSubscriptions

    • (replaces exportPlayers)
    • pplx::task<std::shared_ptr<ExportSubscriptionsSuccessResponse>> exportSubscriptions(utility::string_t appId, boost::optional<std::shared_ptr<Export_subscriptions_request_body>> exportSubscriptionsRequestBody) const = 0;
  • getAliases

    • (replaces fetchUser)
    • pplx::task<std::shared_ptr<UserIdentityBody>> getAliases(utility::string_t appId, utility::string_t aliasLabel, utility::string_t aliasId) const = 0;
  • getAliasesBySubscription

    • (replaces fetchAliases/fetchUserIdentity)
    • pplx::task<std::shared_ptr<UserIdentityBody>> getAliasesBySubscription(utility::string_t appId, utility::string_t subscriptionId) const = 0;
  • getSegments

    • (replaces getPlayers)
    • pplx::task<std::shared_ptr<GetSegmentsSuccessResponse>> getSegments(utility::string_t appId, boost::optional<int32_t> offset, boost::optional<int32_t> limit) const = 0;
  • getUser

    • (replaces identifyUserByAlias/fetchUser)
    • pplx::task<std::shared_ptr<User>> getUser(utility::string_t appId, utility::string_t aliasLabel, utility::string_t aliasId) const = 0;
  • transferSubscription

    • (signature changed)
    • pplx::task<std::shared_ptr<UserIdentityBody>> transferSubscription(utility::string_t appId, utility::string_t subscriptionId, std::shared_ptr<TransferSubscriptionRequestBody> transferSubscriptionRequestBody) const = 0;
  • unsubscribeEmailWithToken

    • pplx::task<std::shared_ptr<GenericSuccessBoolResponse>> unsubscribeEmailWithToken(utility::string_t appId, utility::string_t notificationId, utility::string_t token) const = 0;
  • updateUser

    • Signature changed:
      Now returns std::shared_ptr<PropertiesBody>

Modified APIs

  • updateSubscription
    • Parameter changed:
      Now takes std::shared_ptr<SubscriptionBody> subscriptionBody instead of UpdateSubscriptionRequestBody

Removed APIs

  • beginLiveActivity
  • endLiveActivity
  • createPlayer
  • deletePlayer
  • deleteSegments (renamed and replaced with deleteSegment)
  • exportPlayers (replaced by exportSubscriptions)
  • fetchAliases
  • fetchUser
  • fetchUserIdentity
  • getEligibleIams
  • getPlayer
  • getPlayers
  • identifyUserByAlias
  • identifyUserBySubscriptionId
  • updatePlayer
  • updatePlayerTags

@sherwinski sherwinski merged commit c6de65d 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