Update CPP API

Author: OneSignal

LICENSE

@@ -0,0 +1,24 @@
+Modified MIT License
+
+Copyright 2022 OneSignal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+1. The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+2. All copies of substantial portions of the Software may only be used in connection
+with services provided by OneSignal.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -5,7 +5,7 @@ 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
+- API version: 1.0.1
 - Package version: 
 - Build package: org.openapitools.codegen.languages.CppRestSdkClientCodegen
 For more information, please visit [https://onesignal.com](https://onesignal.com)
@@ -20,13 +20,43 @@ For more information, please visit [https://onesignal.com](https://onesignal.com
 Install [cpprestsdk](https://github.com/Microsoft/cpprestsdk).
 
 - Windows: `vcpkg install cpprestsdk cpprestsdk:x64-windows boost-uuid boost-uuid:x64-windows`
-- Mac: `brew install cpprestsdk`
+- Mac:
+    `brew install cpprestsdk`
+    `brew install openssl`
 - Linux: `sudo apt-get install libcpprest-dev`
 
+### Cmake integration
+You can `cmake --install .` and then use `find_package(CppRestOneSignalAPIClient REQUIRED)`.
+Alternatively you can have it as a subdirectory as in the example below.
+
+
+Take a look on our test `CMakeLists.txt`:
+```
+cmake_minimum_required(VERSION 3.22)
+project(CppRestOneSignalAPIClientTest)
+
+set(CMAKE_CXX_STANDARD 14)
+
+# Test dependencies
+find_package(Catch2 REQUIRED)
+
+# OneSignal Client Library
+add_subdirectory(deps/onesignal)
+
+# Executables for tests
+add_executable(tests test.cpp)
+
+target_link_libraries(tests Catch2::Catch2 CppRestOneSignalAPIClient)
+```
+
 ### Build
 
 ```sh
-cmake -DCPPREST_ROOT=/usr -DCMAKE_CXX_FLAGS="-I/usr/local/opt/openssl/include" -DCMAKE_MODULE_LINKER_FLAGS="-L/usr/local/opt/openssl/lib"
+cmake -DCMAKE_CXX_FLAGS="-I/usr/local/include -I/usr/local/Cellar/include -I/usr/local/opt/include" \
+-DCMAKE_MODULE_LINKER_FLAGS="-L/usr/local/lib -L/usr/local/Cellar/lib -L/usr/local/opt/lib" \
+-DCMAKE_EXE_LINKER_FLAGS="-L/usr/local/lib -L/usr/local/Cellar/lib -L/usr/local/opt/lib -L/usr/local/opt/openssl/lib" \
+-DOPENSSL_ROOT_DIR=/usr/local/opt/openssl \
+-DOPENSSL_LIBRARIES=/usr/local/opt/openssl/lib \
 make
 ```
 
@@ -45,6 +75,226 @@ C++ tools for CMake' is selected in the 'Installation Details' section.
 
 Also be sure to review the CMakeLists.txt file. Edits are likely required.*
 
+## How to use
+### Initializing the OneSignal CPP Client library
+```cgo
+#include "CppRestOneSignalAPIClient/ApiClient.h"
+#include "CppRestOneSignalAPIClient/ApiConfiguration.h"
+#include "CppRestOneSignalAPIClient/api/DefaultApi.h"
+
+using com::onesignal::client::api::ApiClient;
+using com::onesignal::client::api::ApiConfiguration;
+using com::onesignal::client::api::DefaultApi;
+
+using utility::string_t;
+using utility::conversions::to_string_t;
+
+const std::string APP_ID = "<YOUR_APP_ID>";
+const std::string APP_KEY_TOKEN = "<YOUR_APP_KEY_TOKEN>";
+const std::string USER_KEY_TOKEN = "<YOUR_USER_KEY_TOKEN>";
+
+static DefaultApi * createApi() {
+    // Settings up the client
+    const auto configuration = ApiClient::getDefaultConfiguration();
+    configuration->setAppKeyToken(APP_KEY_TOKEN);
+    configuration->setUserKeyToken(USER_KEY_TOKEN);
+
+    const auto apiClient = std::make_shared<ApiClient>(configuration);
+
+    return new DefaultApi(apiClient);
+}
+
+```
+
+### Creating a notification
+```cgo
+static std::shared_ptr<Notification> createNotification() {
+    const auto notification = std::make_shared<Notification>();
+    notification->setAppId(APP_ID);
+
+    const auto content = std::make_shared<StringMap>();
+    content->setEn(to_string_t("OneSignal C++ Client Test: Create notification"));
+    std::vector<string_t> vect{ to_string_t("Active Users") };
+
+    notification->setContents(content);
+    notification->setIncludedSegments(vect);
+    notification->setIsAnyWeb(true);
+    notification->setIsChrome(true);
+
+    return notification;
+}
+```
+### Sending a notification
+```cgo
+const auto api = createApi();
+
+// Creating a notification
+const auto notification = createNotification();
+
+// Send a notification
+const auto response = api->createNotification(notification);
+const auto & responseData = response.get();
+
+// Check the result
+CHECK(responseData->getId().size() > 0);
+CHECK_FALSE(responseData->errorsIsSet());
+```
+
+### Sending and canceling scheduled notification
+```cgo
+const auto api = createApi();
+
+// Create a scheduled notification
+const auto notification = createNotification();
+
+notification->setSendAfter(utility::datetime().utc_now() + utility::datetime().from_hours(1));
+
+// Send a notification
+const auto sendResponse = api->createNotification(notification);
+const auto & sendResponseData = sendResponse.get();
+
+// Cancel a scheduled notification
+const auto cancelResponse = api->cancelNotification(APP_ID, sendResponseData->getId());
+const auto & cancelResponseData = cancelResponse.get();
+
+// Check the result
+CHECK(cancelResponseData->isSuccess());
+```
+
+### Getting a notification
+```cgo
+const auto api = createApi();
+
+// Get a notification
+const auto getResponse = api->getNotification(APP_ID, "<your_notification_id>");
+const auto & getResponseData = getResponse.get();
+
+// Check the result
+CHECK(getResponseData->getId() == sendResponseData->getId());
+```
+
+### Getting a list of notifications
+```cgo
+const auto api = createApi();
+
+// Creating a notification
+const auto notification = createNotification();
+
+// Get list of notification with the limit of 10
+const auto getResponse = api->getNotifications(APP_ID, 10, boost::none, boost::none);
+const auto & notificationSlice = getResponse.get();
+
+// Check the result
+CHECK(notificationSlice->getNotifications().size() == 10);
+```
+
+### Creating and getting a player
+```cgo
+static std::shared_ptr<Player> createPlayer() {
+    const auto player = std::make_shared<Player>();
+
+    player->setAppId(APP_ID);
+    player->setIdentifier("Id_example");
+    player->setDeviceType(1);
+
+    return player;
+}
+```
+
+```cgo
+const auto api = createApi();
+
+// Creating a player
+const auto player = createPlayer();
+
+// Send a create request
+const auto createResponse = api->createPlayer(player);
+const auto & createResponseData = createResponse.get();
+
+// Send a get request
+const auto getResponse = api->getPlayer(APP_ID, createResponseData->getId(), boost::none);
+const auto & getResponseData = getResponse.get();
+
+CHECK(createResponseData->isSuccess());
+CHECK(getResponseData->getId() == createResponseData->getId());
+```
+
+### Creating and deleting a segment
+```cgo
+static std::shared_ptr<Segment> createSegment(string_t segmentName) {
+    // Setting up filters
+    const auto filterExpressions = std::make_shared<FilterExpressions>();
+    filterExpressions->setField(to_string_t("session_count"));
+    filterExpressions->setRelation(to_string_t(">"));
+    filterExpressions->setValue("1");
+
+    std::vector<std::shared_ptr<FilterExpressions>> vect;
+    vect.push_back(filterExpressions);
+
+    // Setting up the segment
+    const auto segment = std::make_shared<Segment>();
+    segment->setName(segmentName);
+    segment->setFilters(vect);
+
+    return segment;
+}
+```
+
+```cgo
+const auto api = createApi();
+
+// Creating a segment
+const auto segment = createSegment("<test_segment_name>");
+
+// Send a create request
+const auto createResponse = api->createSegments(APP_ID, segment);
+const auto & createResponseData = createResponse.get();
+
+sleep(10);
+
+// Send a delete request
+const auto deleteResponse = api->deleteSegments(APP_ID, createResponseData->getId());
+const auto & deleteResponseData = deleteResponse.get();
+
+// Check the result
+CHECK(deleteResponseData->isSuccess());
+```
+
+### Getting an App
+```cgo
+const auto api = createApi();
+
+// Send a get request
+const auto getResponse = api->getApp(APP_ID);
+const auto & app = getResponse.get();
+
+// Check the result
+CHECK(app->getId() == APP_ID);
+```
+
+### Getting outcomes
+```cgo
+const auto api = createApi();
+
+// Set up the request
+const auto outcomeNames = to_string_t("os__session_duration.count,os__click.count");
+const auto outcomeTimeRange = to_string_t("1d");
+const auto outcomePlatforms = to_string_t("5");
+const auto outcomeAttribution = to_string_t("direct");
+
+// Send the request
+const auto outcomesResponse = api->getOutcomes(APP_ID,
+                                               outcomeNames,
+                                               boost::none,
+                                               outcomeTimeRange,
+                                               outcomePlatforms,
+                                               outcomeAttribution);
+const auto outcomes = outcomesResponse.get()->getOutcomes();
+
+// Check the result
+CHECK(outcomes.size() > 0);
+```
+
 ## 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.0.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.
@@ -64,6 +64,7 @@ class  ApiClient
     static utility::string_t parameterToString(double value);
     static utility::string_t parameterToString(const utility::datetime &value);
     static utility::string_t parameterToString(bool value);
+    static std::shared_ptr<ApiConfiguration> getDefaultConfiguration();
     template<class T>
     static utility::string_t parameterToString(const std::vector<T>& value);
     template<class T>

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.0.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.
@@ -52,10 +52,18 @@ class  ApiConfiguration
     utility::string_t getApiKey( const utility::string_t& prefix) const;
     void setApiKey( const utility::string_t& prefix, const utility::string_t& apiKey );
 
+    utility::string_t getBearerToken( const utility::string_t& prefix ) const;
+    void setBearerToken( const utility::string_t& prefix, const utility::string_t& bearerToken );
+
+    void setAppKeyToken( const utility::string_t& bearerToken );
+    void setUserKeyToken( const utility::string_t& bearerToken );
+
+
 protected:
     utility::string_t m_BaseUrl;
     std::map<utility::string_t, utility::string_t> m_DefaultHeaders;
     std::map<utility::string_t, utility::string_t> m_ApiKeys;
+    std::map<utility::string_t, utility::string_t> m_BearerTokens;
     web::http::client::http_client_config m_HttpConfig;
     utility::string_t m_UserAgent;
 };

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.0.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.0.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.0.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.0.1
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI-Generator 6.0.0-SNAPSHOT.