onesignal 5.7.0 → 5.9.0

data/docs/DefaultApi.md

@@ -100,12 +100,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 notification_id = 'b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88' # String | 
 
 begin
@@ -178,13 +178,13 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
 template_id = 'e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c' # String | 
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 copy_template_request = OneSignal::CopyTemplateRequest.new({target_app_id: 'target_app_id_example'}) # CopyTemplateRequest | 
 
 begin
@@ -258,12 +258,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 alias_label = 'external_id' # String | 
 alias_id = 'YOUR_USER_EXTERNAL_ID' # String | 
 user_identity_body = OneSignal::UserIdentityBody.new # UserIdentityBody | 
@@ -340,12 +340,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 subscription_id = '7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51' # String | 
 user_identity_body = OneSignal::UserIdentityBody.new # UserIdentityBody | 
 
@@ -420,12 +420,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 create_api_key_request = OneSignal::CreateApiKeyRequest.new # CreateApiKeyRequest | 
 
 begin
@@ -498,7 +498,7 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
@@ -574,12 +574,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | Your OneSignal App ID in UUID v4 format.
+app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
 custom_events_request = OneSignal::CustomEventsRequest.new({events: [OneSignal::CustomEvent.new({name: 'name_example'})]}) # CustomEventsRequest | 
 
 begin
@@ -652,7 +652,7 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
@@ -662,6 +662,7 @@ require 'securerandom'
 notification = OneSignal::Notification.new
 notification.app_id = 'YOUR_APP_ID'
 notification.contents = OneSignal::LanguageStringMap.new({ en: 'Hello from OneSignal!' })
+notification.headings = OneSignal::LanguageStringMap.new({ en: 'Push Notification' })
 notification.include_aliases = { 'external_id' => ['YOUR_USER_EXTERNAL_ID'] }
 notification.target_channel = 'push'
 # Idempotency key: a client-generated UUID that lets you safely retry on network failure.
@@ -704,13 +705,14 @@ The `create_notification_with_retry` method mirrors `create_notification` but ge
 require 'onesignal'
 
 OneSignal.configure do |config|
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 end
 
 api_instance = OneSignal::DefaultApi.new
 notification = OneSignal::Notification.new
 notification.app_id = 'YOUR_APP_ID'
 notification.contents = OneSignal::LanguageStringMap.new({ en: 'Hello from OneSignal!' })
+notification.headings = OneSignal::LanguageStringMap.new({ en: 'Push Notification' })
 notification.include_aliases = { 'external_id' => ['YOUR_USER_EXTERNAL_ID'] }
 notification.target_channel = 'push'
 # No idempotency_key set: the helper generates a UUIDv4 and reuses it across retries.
@@ -784,14 +786,14 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
+app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
 opts = {
-  segment: OneSignal::Segment.new({name: 'name_example', filters: [OneSignal::Filter.new]}) # Segment | 
+  segment: OneSignal::Segment.new({name: 'Inactive 30 days', filters: [OneSignal::Filter.new]}) # Segment | 
 }
 
 begin
@@ -864,12 +866,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 alias_label = 'external_id' # String | 
 alias_id = 'YOUR_USER_EXTERNAL_ID' # String | 
 subscription_body = OneSignal::SubscriptionBody.new # SubscriptionBody | 
@@ -946,7 +948,7 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
@@ -1022,12 +1024,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 user = OneSignal::User.new # User | 
 
 begin
@@ -1112,12 +1114,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 alias_label = 'external_id' # String | 
 alias_id = 'YOUR_USER_EXTERNAL_ID' # String | 
 alias_label_to_delete = 'external_id' # String | 
@@ -1194,12 +1196,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 token_id = '0aa1b2c3-d4e5-46f7-8899-aabbccddeeff' # String | 
 
 begin
@@ -1272,12 +1274,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
+app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
 segment_id = 'd6c5a3e1-9f17-44a1-9d10-7c0e4a2b1c8e' # String | The segment_id can be found in the URL of the segment when viewing it in the dashboard.
 
 begin
@@ -1350,12 +1352,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 subscription_id = '7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51' # String | 
 
 begin
@@ -1427,13 +1429,13 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
 template_id = 'e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c' # String | 
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 
 begin
   # Delete template
@@ -1505,12 +1507,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 alias_label = 'external_id' # String | 
 alias_id = 'YOUR_USER_EXTERNAL_ID' # String | 
 
@@ -1584,13 +1586,13 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
 notification_id = 'b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88' # String | The ID of the notification to export events from.
-app_id = '00000000-0000-0000-0000-000000000000' # String | The ID of the app that the notification belongs to.
+app_id = 'YOUR_APP_ID' # String | The ID of the app that the notification belongs to.
 
 begin
   # Export CSV of Events
@@ -1662,12 +1664,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | The app ID that you want to export devices from
+app_id = 'YOUR_APP_ID' # String | The app ID that you want to export devices from
 opts = {
   export_subscriptions_request_body: OneSignal::ExportSubscriptionsRequestBody.new # ExportSubscriptionsRequestBody | 
 }
@@ -1742,12 +1744,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 alias_label = 'external_id' # String | 
 alias_id = 'YOUR_USER_EXTERNAL_ID' # String | 
 
@@ -1822,12 +1824,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 subscription_id = '7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51' # String | 
 
 begin
@@ -1900,12 +1902,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | An app id
+app_id = 'YOUR_APP_ID' # String | An app id
 
 begin
   # View an app
@@ -1976,7 +1978,7 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
@@ -2049,12 +2051,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 notification_id = 'b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88' # String | 
 
 begin
@@ -2127,7 +2129,7 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
@@ -2205,16 +2207,17 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | The app ID that you want to view notifications from
+app_id = 'YOUR_APP_ID' # String | The app ID that you want to view notifications from
 opts = {
   limit: 10, # Integer | How many notifications to return.  Max is 50.  Default is 50.
   offset: 0, # Integer | Page offset.  Default is 0.  Results are sorted by queued_at in descending order.  queued_at is a representation of the time that the notification was queued at.
-  kind: 0 # Integer | Kind of notifications returned:   * unset - All notification types (default)   * `0` - Dashboard only   * `1` - API only   * `3` - Automated only 
+  kind: 0, # Integer | Kind of notifications returned:   * unset - All notification types (default)   * `0` - Dashboard only   * `1` - API only   * `3` - Automated only 
+  time_offset: '2025-01-01T00:00:00.000Z' # String | Time-offset pagination cursor for sequential pulls of all messages.  Accepts either an ISO 8601 formatted timestamp (e.g. `2025-01-01T00:00:00.000Z`) or the opaque Base64 cursor token returned as `next_time_offset` in a prior response.  When set, results are sorted ascending by send_after and the standard `offset` parameter cannot be used.  Repeat the request with each `next_time_offset` until an empty notifications array is returned.
 }
 
 begin
@@ -2259,6 +2262,7 @@ end
 | **limit** | **Integer** | How many notifications to return.  Max is 50.  Default is 50. | [optional] |
 | **offset** | **Integer** | Page offset.  Default is 0.  Results are sorted by queued_at in descending order.  queued_at is a representation of the time that the notification was queued at. | [optional] |
 | **kind** | **Integer** | Kind of notifications returned:   * unset - All notification types (default)   * `0` - Dashboard only   * `1` - API only   * `3` - Automated only  | [optional] |
+| **time_offset** | **String** | Time-offset pagination cursor for sequential pulls of all messages.  Accepts either an ISO 8601 formatted timestamp (e.g. `2025-01-01T00:00:00.000Z`) or the opaque Base64 cursor token returned as `next_time_offset` in a prior response.  When set, results are sorted ascending by send_after and the standard `offset` parameter cannot be used.  Repeat the request with each `next_time_offset` until an empty notifications array is returned. | [optional] |
 
 ### Return type
 
@@ -2289,12 +2293,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
+app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
 outcome_names = 'os__session_duration.count,os__click.count' # String | Required Comma-separated list of names and the value (sum/count) for the returned outcome data. Note: Clicks only support count aggregation. For out-of-the-box OneSignal outcomes such as click and session duration, please use the \"os\" prefix with two underscores. For other outcomes, please use the name specified by the user. Example:os__session_duration.count,os__click.count,CustomOutcomeName.sum 
 opts = {
   outcome_names2: 'os__session_duration.count', # String | Optional If outcome names contain any commas, then please specify only one value at a time. Example: outcome_names[]=os__click.count&outcome_names[]=Sales, Purchase.count where \"Sales, Purchase\" is the custom outcomes with a comma in the name. 
@@ -2377,12 +2381,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
+app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
 opts = {
   offset: 0, # Integer | Segments are listed in ascending order of created_at date. offset will omit that number of segments from the beginning of the list. Eg offset 5, will remove the 5 earliest created Segments.
   limit: 10 # Integer | The amount of Segments in the response. Maximum 300.
@@ -2459,12 +2463,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 alias_label = 'external_id' # String | 
 alias_id = 'YOUR_USER_EXTERNAL_ID' # String | 
 
@@ -2539,12 +2543,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 token_id = '0aa1b2c3-d4e5-46f7-8899-aabbccddeeff' # String | 
 
 begin
@@ -2617,12 +2621,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | Your OneSignal App ID in UUID v4 format.
+app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
 activity_type = 'order_status' # String | The name of the Live Activity defined in your app. This should match the attributes struct used in your app's Live Activity implementation.
 start_live_activity_request = OneSignal::StartLiveActivityRequest.new({name: 'name_example', event: 'start', activity_id: 'activity_id_example', event_attributes: 3.56, event_updates: 3.56, contents: OneSignal::LanguageStringMap.new, headings: OneSignal::LanguageStringMap.new}) # StartLiveActivityRequest | 
 
@@ -2697,12 +2701,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 subscription_id = '7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51' # String | 
 transfer_subscription_request_body = OneSignal::TransferSubscriptionRequestBody.new # TransferSubscriptionRequestBody | 
 
@@ -2777,12 +2781,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
+app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
 notification_id = 'b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88' # String | The id of the message found in the creation notification POST response, View Notifications GET response, or URL within the Message Report.
 token = 'YOUR_TOKEN_ID' # String | The unsubscribe token that is generated via liquid syntax in {{subscription.unsubscribe_token}} when personalizing an email.
 
@@ -2857,12 +2861,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 token_id = '0aa1b2c3-d4e5-46f7-8899-aabbccddeeff' # String | 
 update_api_key_request = OneSignal::UpdateApiKeyRequest.new # UpdateApiKeyRequest | 
 
@@ -2937,12 +2941,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | An app id
+app_id = 'YOUR_APP_ID' # String | An app id
 app = OneSignal::App.new # App | 
 
 begin
@@ -3015,12 +3019,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
+app_id = 'YOUR_APP_ID' # String | The OneSignal App ID for your app.  Available in Keys & IDs.
 activity_id = '12345' # String | Live Activity record ID
 update_live_activity_request = OneSignal::UpdateLiveActivityRequest.new({name: 'name_example', event: 'update', event_updates: 3.56}) # UpdateLiveActivityRequest | 
 
@@ -3095,12 +3099,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 subscription_id = '7e4c5b9a-1f60-4d07-9b1a-2e8c8d2cae51' # String | 
 subscription_body = OneSignal::SubscriptionBody.new # SubscriptionBody | 
 
@@ -3174,12 +3178,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | Your OneSignal App ID in UUID v4 format.
+app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
 token_type = 'Email' # String | The type of token to use when looking up the subscription. See Subscription Types.
 token = 'user@example.com' # String | The value of the token to lookup by (e.g., email address, phone number).
 subscription_body = OneSignal::SubscriptionBody.new # SubscriptionBody | 
@@ -3256,13 +3260,13 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
 template_id = 'e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c' # String | 
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 update_template_request = OneSignal::UpdateTemplateRequest.new # UpdateTemplateRequest | 
 
 begin
@@ -3336,12 +3340,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 alias_label = 'external_id' # String | 
 alias_id = 'YOUR_USER_EXTERNAL_ID' # String | 
 update_user_request = OneSignal::UpdateUserRequest.new # UpdateUserRequest | 
@@ -3418,12 +3422,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: organization_api_key
-  config.organization_api_key = 'YOUR_BEARER_TOKEN'
+  config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 
 begin
   # View API keys
@@ -3494,13 +3498,13 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
 template_id = 'e4d3c2b1-a09f-4f1e-8d7c-6b5a4f3e2d1c' # String | 
-app_id = '00000000-0000-0000-0000-000000000000' # String | 
+app_id = 'YOUR_APP_ID' # String | 
 
 begin
   # View template
@@ -3572,12 +3576,12 @@ require 'onesignal'
 # setup authorization
 OneSignal.configure do |config|
   # Configure Bearer authorization: rest_api_key
-  config.rest_api_key = 'YOUR_BEARER_TOKEN'
+  config.rest_api_key = 'YOUR_REST_API_KEY'
 
 end
 
 api_instance = OneSignal::DefaultApi.new
-app_id = '00000000-0000-0000-0000-000000000000' # String | Your OneSignal App ID in UUID v4 format.
+app_id = 'YOUR_APP_ID' # String | Your OneSignal App ID in UUID v4 format.
 opts = {
   limit: 10, # Integer | Maximum number of templates. Default and max is 50.
   offset: 0, # Integer | Pagination offset.

data/docs/DeliveryData.md

@@ -16,11 +16,11 @@
 require 'onesignal'
 
 instance = OneSignal::DeliveryData.new(
-  successful: null,
-  failed: null,
-  errored: null,
-  converted: null,
-  received: null
+  successful: nil,
+  failed: nil,
+  errored: nil,
+  converted: nil,
+  received: nil
 )
 ```