Update CPP API (#13)

Co-authored-by: OneSignal <[email protected]>

Author: onesignal-deploy

.github/workflows/Zapier.yml

@@ -7,7 +7,7 @@ on:
   # Triggers the workflow on push or pull request events but only for the "main" branch
   issues:
     types: [closed]
-    
+
 permissions:
   issues: read
 
@@ -31,4 +31,4 @@ jobs:
           --header 'Accept: application/json' \
           --data-raw '{
             "task_name" : "$ISSUE_TITLE"
-          }'
+          }'

README.md

@@ -5,8 +5,8 @@ A powerful way to send personalized messages at scale and build effective custom
 ## Overview
 This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI spec](https://openapis.org) from a remote server, you can easily generate an API client.
 
-- API version: 1.0.2
-- Package version: 1.0.4
+- API version: 1.2.1
+- Package version: 2.0.0
 - Build package: org.openapitools.codegen.languages.CppRestSdkClientCodegen
 For more information, please visit [https://onesignal.com](https://onesignal.com)
 
@@ -60,6 +60,9 @@ cmake -DCMAKE_CXX_FLAGS="-I/usr/local/include -I/usr/local/Cellar/include -I/usr
 make
 ```
 
+> Note, if you are getting compilation errors related to missing dependencies, and you installed them using different package managers
+like Homebrew, you may need to alter cmake flags with appropriate paths.
+
 ### Build on Windows with Visual Studio (VS2017)
 
 - Right click on folder containing source code
@@ -106,7 +109,9 @@ static DefaultApi * createApi() {
 
 ```
 
-### Creating a notification
+> If you use this library synchronously, make sure you call .get() to wait for the response and wrap it in a try-catch block, so you can see the errors if there are any.
+
+### Creating a notification model
 ```cpp
 static std::shared_ptr<Notification> createNotification() {
     const auto notification = std::make_shared<Notification>();
@@ -275,26 +280,23 @@ const auto api = createApi();
 const auto segment = createSegment("<test_segment_name>");
 
 // Send a create request
-const auto createResponse = api->createSegments(APP_ID, segment);
-const auto & createResponseData = createResponse.get();
+const auto createResponse = api->createSegments(APP_ID, segment).get();
 
 sleep(10);
 
 // Send a delete request
-const auto deleteResponse = api->deleteSegments(APP_ID, createResponseData->getId());
-const auto & deleteResponseData = deleteResponse.get();
+const auto deleteResponse = api->deleteSegments(APP_ID, createResponse->getId()).get();
 
 // Check the result
-CHECK(deleteResponseData->isSuccess());
+CHECK(deleteResponse->isSuccess());
 ```
 
 ### Getting an App
 ```cpp
 const auto api = createApi();
 
 // Send a get request
-const auto getResponse = api->getApp(APP_ID);
-const auto & app = getResponse.get();
+const auto app = api->getApp(APP_ID).get();
 
 // Check the result
 CHECK(app->getId() == APP_ID);
@@ -349,6 +351,147 @@ api->updateLiveActivity(APP_ID, "activity id example", updateLiveActivityRequest
 api->endLiveActivity(APP_ID, "activity id example", "player id example");
 ```
 
+## Users
+### Create User
+```cpp
+// Creating a user model to be send to the server
+const auto user = std::make_shared<User>();
+const auto aliasLabel = "<ALIAS_LABEL>";
+const auto aliasId = "<ALIAS_ID>";
+const auto pushToken = "<DEVICE_PUSH_TOKEN>";
+
+std::map<utility::string_t, utility::string_t> identity = {};
+identity[aliasLabel] = aliasId;
+user->setIdentity(identity);
+
+com::onesignal::client::model::SubscriptionObject subscriptionObject;
+subscriptionObject.setToken(pushToken);
+subscriptionObject.setType("iOSPush");
+std::vector<std::shared_ptr<com::onesignal::client::model::SubscriptionObject>> subscriptions = {
+        std::make_shared<com::onesignal::client::model::SubscriptionObject>(subscriptionObject)
+};
+
+// Sending to to the server
+const auto createUserResponse = api->createUser(APP_ID, user).get();
+```
+
+### Fetch user by alias
+```cpp
+const auto fetchUserResponse = api->fetchUser(APP_ID, <ALIAS_LABEL>, <ALIAS_ID>).get();
+```
+
+### Update user
+```cpp
+const auto updateUserRequest = std::make_shared<UpdateUserRequest>();
+const auto propertiesObject = std::make_shared<PropertiesObject>();
+propertiesObject->setLanguage("fr");
+updateUserRequest->setProperties(propertiesObject);
+
+const auto updateUserResponse = api->updateUser(APP_ID, "<ALIAS_LABEL>", "<ALIAS_ID>", updateUserRequest).get();
+CHECK(updateUserResponse->getProperties()->getLanguage() == "fr");
+```
+
+### Delete user
+```cpp
+api->deleteUser(APP_ID, "<ALIAS_LABEL>", "<ALIAS_ID>").get();
+```
+
+### Create subscription
+```cpp
+const auto subscriptionObject = std::make_shared<SubscriptionObject>();
+subscriptionObject->setType("AndroidPush");
+subscriptionObject->setToken("<DEVICE_PUSH_TOKEN>");
+const auto createSubscriptionRequestBody = std::make_shared<CreateSubscriptionRequestBody>();
+createSubscriptionRequestBody->setSubscription(subscriptionObject);
+
+const auto createSubscriptionResponse = api->createSubscription(APP_ID, "<ALIAS_LABEL>", "<ALIAS_ID>",
+                                                                createSubscriptionRequestBody).get();
+
+CHECK(createSubscriptionResponse->getSubscription()->getToken().length() != 0);
+```
+
+### Update subscription
+```cpp
+subscriptionObject->setType("AndroidPush");
+subscriptionObject->setToken("<DEVICE_PUSH_TOKEN>");
+const auto updateSubscriptionRequestBody = std::make_shared<UpdateSubscriptionRequestBody>();
+updateSubscriptionRequestBody->setSubscription(subscriptionObject);
+
+api->updateSubscription(APP_ID, "<SUBSCRIPTION_ID>", updateSubscriptionRequestBody).get();
+```
+
+### Delete subscription
+```cpp
+api->deleteSubscription(APP_ID, "<SUBSCRIPTION_ID>").get();
+```
+
+### Fetch aliases by subscription id
+```cpp
+const auto fetchAliasesResponse = api->fetchAliases(APP_ID, "<SUBSCRIPTION_ID>").get();
+```
+
+### Fetch aliases by an alias
+```cpp
+const auto fetchUserIdentityResponse = api->fetchUserIdentity(APP_ID, "<ALIAS_LABEL>", "<ALIAS_ID>").get();
+```
+
+### Fetch aliases by subscription id
+```cpp
+const auto fetchAliasesResponse = api->fetchAliases(APP_ID, "<SUBSCRIPTION_ID>").get();
+```
+
+### Identify user by subscription id
+Basically means that you want to add an alias to the user using subscription id.
+```cpp
+const auto subscriptionId = "<SUBSCRIPTION_ID>";
+const auto newAliasLabel = "<NEW_ALIAS_LABEL>";
+const auto newAliasId = "<NEW_ALIAS_ID>";
+std::map<utility::string_t, utility::string_t> identity = {};
+identity[newAliasLabel] = newAliasId;
+user->setIdentity(identity);
+const auto userIdentityRequestBody = std::make_shared<UserIdentityRequestBody>();
+userIdentityRequestBody->setIdentity(identity);
+
+const auto identifyUserBySubscriptionIdResponse =
+        api->identifyUserBySubscriptionId(APP_ID, subscriptionId, userIdentityRequestBody).get();
+
+CHECK(identifyUserBySubscriptionIdResponse->getIdentity()[newAliasLabel] == newAliasId);
+```
+
+### Identify user by an alias
+Basically means that you want to add an alias to the user using another alias.
+```cpp
+const auto subscriptionId = "<SUBSCRIPTION_ID>";
+const auto newAliasLabel = "<NEW_ALIAS_LABEL>";
+const auto newAliasId = "<NEW_ALIAS_ID>";
+std::map<utility::string_t, utility::string_t> identity = {};
+identity[newAliasLabel] = newAliasId;
+user->setIdentity(identity);
+const auto userIdentityRequestBody = std::make_shared<UserIdentityRequestBody>();
+userIdentityRequestBody->setIdentity(identity);
+
+const auto identifyUserBySubscriptionIdResponse =
+        api->identifyUserByAlias(APP_ID, "<ALIAS_LABEL>", "<ALIAS_ID>", userIdentityRequestBody).get();
+
+CHECK(identifyUserBySubscriptionIdResponse->getIdentity()[newAliasLabel] == newAliasId);
+```
+
+### Transfers subscription ownership
+```cpp
+const auto transferSubscriptionRequestBody = std::make_shared<TransferSubscriptionRequestBody>();
+std::map<utility::string_t, utility::string_t> identity = {};
+identity["<USER_FROM_ALIAS_LABEL>"] = "<USER_FROM_ALIAS_ID>";
+transferSubscriptionRequestBody->setIdentity(identity);
+
+const auto identifyUserByAliasResponse =
+        api->transferSubscription(APP_ID, "<USER_TO_SUBSCRIPTION_ID>", transferSubscriptionRequestBody).get();
+```
+
+### Fetch IAMs
+```cpp
+api->getEligibleIams(APP_ID, "<SUBSCRIPTION_ID>").get();
+```
+
 ## Author
 
 [email protected]

include/CppRestOneSignalAPIClient/ApiClient.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.

include/CppRestOneSignalAPIClient/ApiConfiguration.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.

include/CppRestOneSignalAPIClient/ApiException.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.

include/CppRestOneSignalAPIClient/HttpContent.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.

include/CppRestOneSignalAPIClient/IHttpBody.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.

include/CppRestOneSignalAPIClient/JsonBody.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.

include/CppRestOneSignalAPIClient/ModelBase.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.

include/CppRestOneSignalAPIClient/MultipartFormData.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.

include/CppRestOneSignalAPIClient/Object.h

@@ -2,7 +2,7 @@
  * OneSignal
  * A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
  *
- * The version of the OpenAPI document: 1.0.2
+ * The version of the OpenAPI document: 1.2.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.