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

Add v5.1.0-beta1 package updates

Author: sherwinski

README.md

@@ -52,15 +52,15 @@ use GuzzleHttp;
 ### Constants
 ```php
 const APP_ID = '<YOUR_APP_ID>';
-const APP_KEY_TOKEN = '<YOUR_APP_KEY_TOKEN>';
-const USER_KEY_TOKEN = '<YOUR_USER_KEY_TOKEN>';
+const REST_API_KEY_TOKEN = '<YOUR_REST_API_KEY>'; // App REST API key required for most endpoints
+const ORGANIZATION_API_KEY_TOKEN = '<YOUR_ORGANIZATION_API_KEY>'; // Organization key is only required for creating new apps and other top-level endpoints
 ```
 
 ### Configure authorization
 ```php
 $config = Configuration::getDefaultConfiguration()
-    ->setAppKeyToken(APP_KEY_TOKEN)
-    ->setUserKeyToken(USER_KEY_TOKEN);
+    ->setRestApiKeyToken(REST_API_KEY_TOKEN)
+    ->setOrganizationApiKeyToken(ORGANIZATION_API_KEY_TOKEN);
 
 $apiInstance = new DefaultApi(
     new GuzzleHttp\Client(),
@@ -511,12 +511,12 @@ requires app_key and which user_key. You can get the value of these keys from yo
 
 
 
-### rest_api_key
+### organization_api_key
 
 - **Type**: Bearer authentication
 
 
-### user_auth_key
+### rest_api_key
 
 - **Type**: Bearer authentication
 
@@ -526,5 +526,5 @@ requires app_key and which user_key. You can get the value of these keys from yo
 devrel@onesignal.com
 
 
-- API version: `5.0.1`
-    - Package version: `5.0.0-beta1`
+- API version: `5.1.0`
+    - Package version: `5.1.0-beta1`

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "onesignal/onesignal-php-api",
-    "version": "5.0.0-beta1",
+    "version": "5.1.0-beta1",
     "description": "A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com",
     "keywords": [
         "onesignal",

docs/Api/DefaultApi.md

@@ -14,7 +14,7 @@
  *
  * 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: devrel@onesignal.com
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 6.0.0-SNAPSHOT

lib/ApiException.php

@@ -14,7 +14,7 @@
  *
  * 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: devrel@onesignal.com
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -59,18 +59,18 @@ class Configuration
     protected $apiKeyPrefixes = [];
 
     /**
-     * restApiKey access token for OAuth/Bearer authentication
+     * organizationApiKey access token for OAuth/Bearer authentication
      *
      * @var string
      */
-    protected $restApiKeyToken = '';
+    protected $organizationApiKeyToken = '';
 
     /**
-     * userAuthKey access token for OAuth/Bearer authentication
+     * restApiKey access token for OAuth/Bearer authentication
      *
      * @var string
      */
-    protected $userAuthKeyToken = '';
+    protected $restApiKeyToken = '';
 
 
     /**
@@ -99,7 +99,7 @@ class Configuration
      *
      * @var string
      */
-    protected $userAgent = 'OpenAPI-Generator/5.0.0-beta1/PHP';
+    protected $userAgent = 'OpenAPI-Generator/5.1.0-beta1/PHP';
 
     /**
      * Debug switch (default set to false)
@@ -157,49 +157,49 @@ public function getApiKey($apiKeyIdentifier)
     }
 
     /**
-     * Sets the restApiKey access token for OAuth
+     * Sets the organizationApiKey access token for OAuth
      *
      * @param string $accessToken Token for OAuth
      *
      * @return $this
      */
-    public function setRestApiKeyToken($accessToken)
+    public function setOrganizationApiKeyToken($accessToken)
     {
-        $this->restApiKeyToken = $accessToken;
+        $this->organizationApiKeyToken = $accessToken;
         return $this;
     }
 
     /**
-     * Gets the restApiKey access token for OAuth
+     * Gets the organizationApiKey access token for OAuth
      *
      * @return string Access token for OAuth
      */
-    public function getRestApiKeyToken()
+    public function getOrganizationApiKeyToken()
     {
-        return $this->restApiKeyToken;
+        return $this->organizationApiKeyToken;
     }
 
     /**
-     * Sets the userAuthKey access token for OAuth
+     * Sets the restApiKey access token for OAuth
      *
      * @param string $accessToken Token for OAuth
      *
      * @return $this
      */
-    public function setUserAuthKeyToken($accessToken)
+    public function setRestApiKeyToken($accessToken)
     {
-        $this->userAuthKeyToken = $accessToken;
+        $this->restApiKeyToken = $accessToken;
         return $this;
     }
 
     /**
-     * Gets the userAuthKey access token for OAuth
+     * Gets the restApiKey access token for OAuth
      *
      * @return string Access token for OAuth
      */
-    public function getUserAuthKeyToken()
+    public function getRestApiKeyToken()
     {
-        return $this->userAuthKeyToken;
+        return $this->restApiKeyToken;
     }
 
     /**
@@ -430,8 +430,8 @@ public static function toDebugReport()
         $report  = 'PHP SDK (onesignal\client) Debug Report:' . PHP_EOL;
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
-        $report .= '    The version of the OpenAPI document: 5.0.1' . PHP_EOL;
-        $report .= '    SDK Package Version: 5.0.0-beta1' . PHP_EOL;
+        $report .= '    The version of the OpenAPI document: 5.1.0' . PHP_EOL;
+        $report .= '    SDK Package Version: 5.1.0-beta1' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;

lib/Configuration.php

@@ -14,7 +14,7 @@
  *
  * 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: devrel@onesignal.com
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 6.0.0-SNAPSHOT

lib/HeaderSelector.php

@@ -15,7 +15,7 @@
  *
  * 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: devrel@onesignal.com
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 6.0.0-SNAPSHOT