Skip to content

Releases: OneSignal/onesignal-cpp-api

5.1.0-beta1

06 Jun 21:19
@sherwinski sherwinski
v5.1.0-beta1
425fdc7
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
5.1.0-beta1 Latest
Latest

User Model beta release

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

Changes

Auth Updates

  • ⚠️ Replace setAppKeyToken on ApiClient::getDefaultConfiguration with setRestApiKeyToken
  • ⚠️ Replace setUserKeyToken on ApiClient::getDefaultConfiguration with setOrganizationApiKeyToken

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
Assets 2
Loading

2.2.1

04 Jun 20:13
@sherwinski sherwinski
v2.2.1
c935c2a
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
2.2.1

Fixes

  • set notification_type to be type int32_t, instead of double, on SubscriptionObject
Loading

2.2.0

26 Mar 17:14
@sherwinski sherwinski
v2.2.0
82bdc3f
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
2.2.0

Features

  • deprecate external_id in favor of idempotency_key as basenotification field

Fixes

  • favor Key auth prefix over Bearer
Loading

2.1.0

22 Jan 17:26
@sherwinski sherwinski
v2.1.0
e7adea7
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.
Compare
Choose a tag to compare
2.1.0

Features

  • Add authMethod for deleteUser

Fixes

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