Merge pull request #41 from OneSignal/api

Add v2.2.0 package updates

Author: sherwinski

README.md

@@ -6,8 +6,8 @@ A powerful way to send personalized messages at scale and build effective custom
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.3.0
-- Package version: 2.1.0
+- API version: 1.4.0
+- Package version: 2.2.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://onesignal.com](https://onesignal.com)
 
@@ -24,16 +24,16 @@ gem build onesignal.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./onesignal-2.1.0.gem
+gem install ./onesignal-2.2.0.gem
 ```
 
-(for development, run `gem install --dev ./onesignal-2.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./onesignal-2.2.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'onesignal', '~> 2.1.0'
+    gem 'onesignal', '~> 2.2.0'
 
 ### Install from Git
 

docs/BasicNotification.md

@@ -34,7 +34,8 @@
 | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.  | [optional] |
 | **channel_for_external_user_ids** | **String** | Indicates if the message type when targeting with include_external_user_ids for cases where an email, sms, and/or push subscribers have the same external user id. Example: Use the string \"push\" to indicate you are sending a push notification or the string \"email\"for sending emails or \"sms\"for sending SMS.  | [optional] |
 | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.  |  |
-| **external_id** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **idempotency_key** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same idempotency key. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same idempotency key will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
 | **contents** | [**StringMap**](StringMap.md) |  | [optional] |
 | **headings** | [**StringMap**](StringMap.md) |  | [optional] |
 | **subtitle** | [**StringMap**](StringMap.md) |  | [optional] |
@@ -148,6 +149,7 @@ instance = OneSignal::BasicNotification.new(
   channel_for_external_user_ids: null,
   app_id: null,
   external_id: null,
+  idempotency_key: null,
   contents: null,
   headings: null,
   subtitle: null,

docs/BasicNotificationAllOf.md

@@ -20,7 +20,8 @@
 | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.  | [optional] |
 | **channel_for_external_user_ids** | **String** | Indicates if the message type when targeting with include_external_user_ids for cases where an email, sms, and/or push subscribers have the same external user id. Example: Use the string \"push\" to indicate you are sending a push notification or the string \"email\"for sending emails or \"sms\"for sending SMS.  | [optional] |
 | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.  | [optional] |
-| **external_id** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **idempotency_key** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same idempotency key. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same idempotency key will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
 | **contents** | [**StringMap**](StringMap.md) |  | [optional] |
 | **headings** | [**StringMap**](StringMap.md) |  | [optional] |
 | **subtitle** | [**StringMap**](StringMap.md) |  | [optional] |
@@ -120,6 +121,7 @@ instance = OneSignal::BasicNotificationAllOf.new(
   channel_for_external_user_ids: null,
   app_id: null,
   external_id: null,
+  idempotency_key: null,
   contents: null,
   headings: null,
   subtitle: null,

docs/Notification.md

@@ -34,7 +34,8 @@
 | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.  | [optional] |
 | **channel_for_external_user_ids** | **String** | Indicates if the message type when targeting with include_external_user_ids for cases where an email, sms, and/or push subscribers have the same external user id. Example: Use the string \"push\" to indicate you are sending a push notification or the string \"email\"for sending emails or \"sms\"for sending SMS.  | [optional] |
 | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.  |  |
-| **external_id** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **idempotency_key** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same idempotency key. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same idempotency key will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
 | **contents** | [**StringMap**](StringMap.md) |  | [optional] |
 | **headings** | [**StringMap**](StringMap.md) |  | [optional] |
 | **subtitle** | [**StringMap**](StringMap.md) |  | [optional] |
@@ -149,6 +150,7 @@ instance = OneSignal::Notification.new(
   channel_for_external_user_ids: null,
   app_id: null,
   external_id: null,
+  idempotency_key: null,
   contents: null,
   headings: null,
   subtitle: null,

docs/NotificationWithMeta.md

@@ -34,7 +34,8 @@
 | **is_chrome** | **Boolean** | This flag is not used for web push Please see isChromeWeb for sending to web push users. This flag only applies to Google Chrome Apps & Extensions. Indicates whether to send to all devices registered under your app's Google Chrome Apps & Extension platform.  | [optional] |
 | **channel_for_external_user_ids** | **String** | Indicates if the message type when targeting with include_external_user_ids for cases where an email, sms, and/or push subscribers have the same external user id. Example: Use the string \"push\" to indicate you are sending a push notification or the string \"email\"for sending emails or \"sms\"for sending SMS.  | [optional] |
 | **app_id** | **String** | Required: Your OneSignal Application ID, which can be found in Keys & IDs. It is a UUID and looks similar to 8250eaf6-1a58-489e-b136-7c74a864b434.  |  |
-| **external_id** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **external_id** | **String** | [DEPRECATED] Correlation and idempotency key. A request received with this parameter will first look for another notification with the same external_id. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same external_id will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
+| **idempotency_key** | **String** | Correlation and idempotency key. A request received with this parameter will first look for another notification with the same idempotency key. If one exists, a notification will not be sent, and result of the previous operation will instead be returned. Therefore, if you plan on using this feature, it's important to use a good source of randomness to generate the UUID passed here. This key is only idempotent for 30 days. After 30 days, the notification could be removed from our system and a notification with the same idempotency key will be sent again.   See Idempotent Notification Requests for more details writeOnly: true  | [optional] |
 | **contents** | [**StringMap**](StringMap.md) |  | [optional] |
 | **headings** | [**StringMap**](StringMap.md) |  | [optional] |
 | **subtitle** | [**StringMap**](StringMap.md) |  | [optional] |
@@ -159,6 +160,7 @@ instance = OneSignal::NotificationWithMeta.new(
   channel_for_external_user_ids: null,
   app_id: null,
   external_id: null,
+  idempotency_key: null,
   contents: null,
   headings: null,
   subtitle: null,

lib/onesignal.rb

@@ -3,7 +3,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: 1.3.0
+The version of the OpenAPI document: 1.4.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT

lib/onesignal/api/default_api.rb

@@ -3,7 +3,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: 1.3.0
+The version of the OpenAPI document: 1.4.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT

lib/onesignal/api_client.rb

@@ -3,7 +3,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: 1.3.0
+The version of the OpenAPI document: 1.4.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -90,7 +90,7 @@ def build_request(http_method, path, opts = {})
       url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
-      opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=2.1.0'
+      opts[:header_params]['OS-Usage-Data'] = 'kind=sdk, sdk-name=onesignal-ruby, version=2.2.0'
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}

lib/onesignal/api_error.rb

@@ -3,7 +3,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: 1.3.0
+The version of the OpenAPI document: 1.4.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT

lib/onesignal/configuration.rb

@@ -3,7 +3,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: 1.3.0
+The version of the OpenAPI document: 1.4.0
 Contact: devrel@onesignal.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0-SNAPSHOT
@@ -180,14 +180,14 @@ def auth_settings
             type: 'bearer',
             in: 'header',
             key: 'Authorization',
-            value: "Bearer token=\"#{ app_key }\""
+            value: "Key token=\"#{ app_key }\""
           },
         'user_key' =>
           {
             type: 'bearer',
             in: 'header',
             key: 'Authorization',
-            value: "Bearer token=\"#{ user_key }\""
+            value: "Key token=\"#{ user_key }\""
           },
       }
     end