Merge pull request #52 from OneSignal/user-api-updates

Add v5.1.0-beta1 package updates

Author: sherwinski

README.md

@@ -1,8 +1,8 @@
 # onesignal-java-client
 
 OneSignal
-- API version: 5.0.1
-  - Build date: 2025-05-13T23:45:41.211Z[Etc/UTC]
+- API version: 5.1.0
+  - Build date: 2025-06-05T20:14:26.949Z[Etc/UTC]
 
 A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
 
@@ -41,7 +41,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>org.openapitools</groupId>
   <artifactId>onesignal-java-client</artifactId>
-  <version>5.0.1</version>
+  <version>5.1.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -57,7 +57,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "org.openapitools:onesignal-java-client:5.0.1"
+     implementation "org.openapitools:onesignal-java-client:5.1.0"
   }
 ```
 
@@ -71,7 +71,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/onesignal-java-client-5.0.1.jar`
+* `target/onesignal-java-client-5.1.0.jar`
 * `target/lib/*.jar`
 
 ## Getting Started
@@ -90,8 +90,8 @@ import com.onesignal.client.api.DefaultApi;
 
 public class Example {
   private static final String appId = "YOUR_APP_ID";
-  private static final String appKeyToken = "YOUR_APP_KEY";
-  private static final String userKeyToken = "YOUR_USER_TOKEN";
+  private static final String restApiKey = "YOUR_REST_API_KEY"; // App REST API key required for most endpoints
+  private static final String organizationApiKey = "YOUR_ORGANIZATION_API_KEY"; // Organization key is only required for creating new apps and other top-level endpoints
 
   private static Notification createNotification() {
     Notification notification = new Notification();
@@ -109,10 +109,10 @@ public class Example {
   public static void main(String[] args) {
     // Setting up the client
     ApiClient defaultClient = Configuration.getDefaultApiClient();
-    HttpBearerAuth appKey = (HttpBearerAuth) defaultClient.getAuthentication("app_key");
-    appKey.setBearerToken(appKeyToken);
-    HttpBearerAuth userKey = (HttpBearerAuth) defaultClient.getAuthentication("user_key");
-    userKey.setBearerToken(userKeyToken);
+    HttpBearerAuth restApiAuth = (HttpBearerAuth) defaultClient.getAuthentication("rest_api_key");
+    restApiAuth.setBearerToken(restApiKey);
+    HttpBearerAuth organizationApiAuth = (HttpBearerAuth) defaultClient.getAuthentication("organization_api_key");
+    organizationApiAuth.setBearerToken(organizationApiKey);
     api = new DefaultApi(defaultClient);
 
     // Setting up the notification
@@ -226,11 +226,11 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 Authentication schemes defined for the API:
-### rest_api_key
+### organization_api_key
 
 - **Type**: HTTP basic authentication
 
-### user_auth_key
+### rest_api_key
 
 - **Type**: HTTP basic authentication
 

api/openapi.yaml

@@ -8,7 +8,7 @@ info:
     customer engagement strategies. Learn more at onesignal.com
   termsOfService: https://onesignal.com/tos
   title: OneSignal
-  version: 5.0.1
+  version: 5.1.0
 servers:
 - url: https://api.onesignal.com
 paths:
@@ -326,7 +326,7 @@ paths:
                 $ref: '#/components/schemas/RateLimitError'
           description: Rate Limit Exceeded
       security:
-      - user_auth_key: []
+      - organization_api_key: []
       summary: View apps
       x-accepts: application/json
     post:
@@ -358,7 +358,7 @@ paths:
                 $ref: '#/components/schemas/RateLimitError'
           description: Rate Limit Exceeded
       security:
-      - user_auth_key: []
+      - organization_api_key: []
       summary: Create an app
       x-content-type: application/json
       x-accepts: application/json
@@ -395,7 +395,7 @@ paths:
                 $ref: '#/components/schemas/RateLimitError'
           description: Rate Limit Exceeded
       security:
-      - user_auth_key: []
+      - organization_api_key: []
       summary: View an app
       x-accepts: application/json
     put:
@@ -437,7 +437,7 @@ paths:
                 $ref: '#/components/schemas/RateLimitError'
           description: Rate Limit Exceeded
       security:
-      - user_auth_key: []
+      - organization_api_key: []
       summary: Update an app
       x-content-type: application/json
       x-accepts: application/json
@@ -4048,7 +4048,7 @@ components:
     rest_api_key:
       scheme: bearer
       type: http
-    user_auth_key:
+    organization_api_key:
       scheme: bearer
       type: http
 

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'org.openapitools'
-version = '5.0.1'
+version = '5.1.0'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "org.openapitools",
     name := "onesignal-java-client",
-    version := "5.0.1",
+    version := "5.1.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/DefaultApi.md

@@ -283,9 +283,9 @@ public class Example {
     ApiClient defaultClient = Configuration.getDefaultApiClient();
     defaultClient.setBasePath("https://api.onesignal.com");
 
-    // Configure HTTP bearer authorization: user_auth_key
-    HttpBearerAuth user_auth_key = (HttpBearerAuth) defaultClient.getAuthentication("user_auth_key");
-    user_auth_key.setBearerToken("BEARER TOKEN");
+    // Configure HTTP bearer authorization: organization_api_key
+    HttpBearerAuth organization_api_key = (HttpBearerAuth) defaultClient.getAuthentication("organization_api_key");
+    organization_api_key.setBearerToken("BEARER TOKEN");
 
     DefaultApi apiInstance = new DefaultApi(defaultClient);
     App app = new App(); // App | 
@@ -315,7 +315,7 @@ public class Example {
 
 ### Authorization
 
-[user_auth_key](../README.md#user_auth_key)
+[organization_api_key](../README.md#organization_api_key)
 
 ### HTTP request headers
 
@@ -1227,9 +1227,9 @@ public class Example {
     ApiClient defaultClient = Configuration.getDefaultApiClient();
     defaultClient.setBasePath("https://api.onesignal.com");
 
-    // Configure HTTP bearer authorization: user_auth_key
-    HttpBearerAuth user_auth_key = (HttpBearerAuth) defaultClient.getAuthentication("user_auth_key");
-    user_auth_key.setBearerToken("BEARER TOKEN");
+    // Configure HTTP bearer authorization: organization_api_key
+    HttpBearerAuth organization_api_key = (HttpBearerAuth) defaultClient.getAuthentication("organization_api_key");
+    organization_api_key.setBearerToken("BEARER TOKEN");
 
     DefaultApi apiInstance = new DefaultApi(defaultClient);
     String appId = "appId_example"; // String | An app id
@@ -1259,7 +1259,7 @@ public class Example {
 
 ### Authorization
 
-[user_auth_key](../README.md#user_auth_key)
+[organization_api_key](../README.md#organization_api_key)
 
 ### HTTP request headers
 
@@ -1296,9 +1296,9 @@ public class Example {
     ApiClient defaultClient = Configuration.getDefaultApiClient();
     defaultClient.setBasePath("https://api.onesignal.com");
 
-    // Configure HTTP bearer authorization: user_auth_key
-    HttpBearerAuth user_auth_key = (HttpBearerAuth) defaultClient.getAuthentication("user_auth_key");
-    user_auth_key.setBearerToken("BEARER TOKEN");
+    // Configure HTTP bearer authorization: organization_api_key
+    HttpBearerAuth organization_api_key = (HttpBearerAuth) defaultClient.getAuthentication("organization_api_key");
+    organization_api_key.setBearerToken("BEARER TOKEN");
 
     DefaultApi apiInstance = new DefaultApi(defaultClient);
     try {
@@ -1324,7 +1324,7 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[user_auth_key](../README.md#user_auth_key)
+[organization_api_key](../README.md#organization_api_key)
 
 ### HTTP request headers
 
@@ -1954,9 +1954,9 @@ public class Example {
     ApiClient defaultClient = Configuration.getDefaultApiClient();
     defaultClient.setBasePath("https://api.onesignal.com");
 
-    // Configure HTTP bearer authorization: user_auth_key
-    HttpBearerAuth user_auth_key = (HttpBearerAuth) defaultClient.getAuthentication("user_auth_key");
-    user_auth_key.setBearerToken("BEARER TOKEN");
+    // Configure HTTP bearer authorization: organization_api_key
+    HttpBearerAuth organization_api_key = (HttpBearerAuth) defaultClient.getAuthentication("organization_api_key");
+    organization_api_key.setBearerToken("BEARER TOKEN");
 
     DefaultApi apiInstance = new DefaultApi(defaultClient);
     String appId = "appId_example"; // String | An app id
@@ -1988,7 +1988,7 @@ public class Example {
 
 ### Authorization
 
-[user_auth_key](../README.md#user_auth_key)
+[organization_api_key](../README.md#organization_api_key)
 
 ### HTTP request headers
 

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>onesignal-java-client</artifactId>
     <packaging>jar</packaging>
     <name>onesignal-java-client</name>
-    <version>5.0.1</version>
+    <version>5.1.0</version>
     <url>https://github.com/openapitools/openapi-generator</url>
     <description>OpenAPI Java</description>
     <scm>

src/main/java/com/onesignal/client/ApiCallback.java

@@ -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: 5.0.1
+ * The version of the OpenAPI document: 5.1.0
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/main/java/com/onesignal/client/ApiClient.java

@@ -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: 5.0.1
+ * The version of the OpenAPI document: 5.1.0
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -90,8 +90,8 @@ public ApiClient() {
         initHttpClient();
 
         // Setup authentications (key: authentication name, value: authentication).
+        authentications.put("organization_api_key", new HttpBearerAuth("Key"));
         authentications.put("rest_api_key", new HttpBearerAuth("Key"));
-        authentications.put("user_auth_key", new HttpBearerAuth("Key"));
         // Prevent the authentications from being modified.
         authentications = Collections.unmodifiableMap(authentications);
     }
@@ -107,8 +107,8 @@ public ApiClient(OkHttpClient client) {
         httpClient = client;
 
         // Setup authentications (key: authentication name, value: authentication).
+        authentications.put("organization_api_key", new HttpBearerAuth("Key"));
         authentications.put("rest_api_key", new HttpBearerAuth("Key"));
-        authentications.put("user_auth_key", new HttpBearerAuth("Key"));
         // Prevent the authentications from being modified.
         authentications = Collections.unmodifiableMap(authentications);
     }
@@ -133,7 +133,7 @@ private void init() {
         json = new JSON();
 
         // Set default User-Agent.
-        setUserAgent("OpenAPI-Generator/5.0.1/java");
+        setUserAgent("OpenAPI-Generator/5.1.0/java");
 
         authentications = new HashMap<String, Authentication>();
     }

src/main/java/com/onesignal/client/ApiException.java

@@ -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: 5.0.1
+ * The version of the OpenAPI document: 5.1.0
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,7 @@
  * <p>ApiException class.</p>
  */
 @SuppressWarnings("serial")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-05-13T23:45:41.211Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-06-05T20:14:26.949Z[Etc/UTC]")
 public class ApiException extends Exception {
     private int code = 0;
     private Map<String, List<String>> responseHeaders = null;

src/main/java/com/onesignal/client/ApiResponse.java

@@ -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: 5.0.1
+ * The version of the OpenAPI document: 5.1.0
  * Contact: [email protected]
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).