onesignal 5.2.1.pre.beta1 → 5.3.0

data/docs/Notification.md

@@ -105,6 +105,7 @@
 | **email_body** | **String** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid.  | [optional] |
 | **email_from_name** | **String** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings.  | [optional] |
 | **email_from_address** | **String** | Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings.  | [optional] |
+| **email_reply_to_address** | **String** | Channel: Email The email address where replies should be sent. If not specified, replies will go to the from address.  | [optional] |
 | **email_preheader** | **String** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null.  | [optional] |
 | **disable_email_click_tracking** | **Boolean** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional] |
 | **include_unsubscribed** | **Boolean** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional] |
@@ -112,6 +113,11 @@
 | **sms_media_urls** | **Array<String>** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs.  | [optional] |
 | **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [optional] |
 | **custom_data** | **Object** | Channel: All JSON object that can be used as a source of message personalization data for fields that support tag variable substitution. Push, SMS: Can accept up to 2048 bytes of valid JSON. Email: Can accept up to 10000 bytes of valid JSON. Example: {\"order_id\": 123, \"currency\": \"USD\", \"amount\": 25}  | [optional] |
+| **huawei_badge_class** | **String** | Channel: Push Notifications Platform: Huawei Full path of the app entry activity class | [optional] |
+| **huawei_badge_add_num** | **Integer** | Channel: Push Notifications Platform: Huawei Accumulative badge number, which is an integer ranging from 1 to 99 | [optional] |
+| **huawei_badge_set_num** | **Integer** | Channel: Push Notifications Platform: Huawei Badge number, which is an integer ranging from 0 to 99 | [optional] |
+| **huawei_category** | **String** | Channel: Push Notifications Platform: Huawei Category of the push notification for HMS classification. | [optional] |
+| **huawei_bi_tag** | **String** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] |
 | **send_after** | **Time** | Channel: All Schedule notification for future delivery. API defaults to UTC -1100 Examples: All examples are the exact same date & time. \"Thu Sep 24 2015 14:00:00 GMT-0700 (PDT)\" \"September 24th 2015, 2:00:00 pm UTC-07:00\" \"2015-09-24 14:00:00 GMT-0700\" \"Sept 24 2015 14:00:00 GMT-0700\" \"Thu Sep 24 2015 14:00:00 GMT-0700 (Pacific Daylight Time)\" Note: SMS currently only supports send_after parameter.  | [optional] |
 
 ## Example
@@ -221,6 +227,7 @@ instance = OneSignal::Notification.new(
   email_body: null,
   email_from_name: null,
   email_from_address: null,
+  email_reply_to_address: null,
   email_preheader: null,
   disable_email_click_tracking: null,
   include_unsubscribed: null,
@@ -228,6 +235,11 @@ instance = OneSignal::Notification.new(
   sms_media_urls: null,
   filters: null,
   custom_data: null,
+  huawei_badge_class: null,
+  huawei_badge_add_num: null,
+  huawei_badge_set_num: null,
+  huawei_category: null,
+  huawei_bi_tag: null,
   send_after: null
 )
 ```

data/docs/NotificationWithMeta.md

@@ -105,6 +105,7 @@
 | **email_body** | **String** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid.  | [optional] |
 | **email_from_name** | **String** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings.  | [optional] |
 | **email_from_address** | **String** | Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings.  | [optional] |
+| **email_reply_to_address** | **String** | Channel: Email The email address where replies should be sent. If not specified, replies will go to the from address.  | [optional] |
 | **email_preheader** | **String** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null.  | [optional] |
 | **disable_email_click_tracking** | **Boolean** | Channel: Email Default is `false`. If set to `true`, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked. | [optional] |
 | **include_unsubscribed** | **Boolean** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional] |
@@ -112,6 +113,11 @@
 | **sms_media_urls** | **Array<String>** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs.  | [optional] |
 | **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [optional] |
 | **custom_data** | **Object** | Channel: All JSON object that can be used as a source of message personalization data for fields that support tag variable substitution. Push, SMS: Can accept up to 2048 bytes of valid JSON. Email: Can accept up to 10000 bytes of valid JSON. Example: {\"order_id\": 123, \"currency\": \"USD\", \"amount\": 25}  | [optional] |
+| **huawei_badge_class** | **String** | Channel: Push Notifications Platform: Huawei Full path of the app entry activity class | [optional] |
+| **huawei_badge_add_num** | **Integer** | Channel: Push Notifications Platform: Huawei Accumulative badge number, which is an integer ranging from 1 to 99 | [optional] |
+| **huawei_badge_set_num** | **Integer** | Channel: Push Notifications Platform: Huawei Badge number, which is an integer ranging from 0 to 99 | [optional] |
+| **huawei_category** | **String** | Channel: Push Notifications Platform: Huawei Category of the push notification for HMS classification. | [optional] |
+| **huawei_bi_tag** | **String** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] |
 | **successful** | **Integer** | Number of notifications that were successfully delivered. | [optional] |
 | **failed** | **Integer** | Number of notifications that could not be delivered due to those devices being unsubscribed. | [optional] |
 | **errored** | **Integer** | Number of notifications that could not be delivered due to an error. You can find more information by viewing the notification in the dashboard. | [optional] |
@@ -232,6 +238,7 @@ instance = OneSignal::NotificationWithMeta.new(
   email_body: null,
   email_from_name: null,
   email_from_address: null,
+  email_reply_to_address: null,
   email_preheader: null,
   disable_email_click_tracking: null,
   include_unsubscribed: null,
@@ -239,6 +246,11 @@ instance = OneSignal::NotificationWithMeta.new(
   sms_media_urls: null,
   filters: null,
   custom_data: null,
+  huawei_badge_class: null,
+  huawei_badge_add_num: null,
+  huawei_badge_set_num: null,
+  huawei_category: null,
+  huawei_bi_tag: null,
   successful: null,
   failed: null,
   errored: null,

data/docs/StartLiveActivityRequest.md

@@ -0,0 +1,48 @@
+# OneSignal::StartLiveActivityRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | An internal name to assist with your campaign organization. This does not get displayed in the message itself. |  |
+| **event** | **String** |  | [default to 'start'] |
+| **activity_id** | **String** | Set a unique activity_id to track and manage the Live Activity. |  |
+| **event_attributes** | **Object** | Default/static data to initialize the Live Activity upon start. |  |
+| **event_updates** | **Object** | Dynamic content used to update the running Live Activity at start. Must match the ContentState interface defined in your app. |  |
+| **contents** | [**LanguageStringMap**](LanguageStringMap.md) |  |  |
+| **headings** | [**LanguageStringMap**](LanguageStringMap.md) |  |  |
+| **stale_date** | **Integer** | Accepts Unix timestamp in seconds. When time reaches the configured stale date, the system considers the Live Activity out of date, and the ActivityState of the Live Activity changes to ActivityState.stale. | [optional] |
+| **priority** | **Integer** | Delivery priority through the push provider (APNs). Pass 10 for higher priority notifications, or 5 for lower priority notifications. Lower priority notifications are sent based on the power considerations of the end user's device. If not set, defaults to 10. | [optional] |
+| **ios_relevance_score** | **Float** | iOS 15+. A score to indicate how a notification should be displayed when grouped. Use a float between 0-1. | [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] |
+| **include_aliases** | **Hash<String, Array<String>>** | Target specific users by aliases assigned via API. An alias can be an external_id, onesignal_id, or a custom alias. Accepts an object where keys are alias labels and values are arrays of alias IDs to include Example usage: { \"external_id\": [\"exId1\", \"extId2\"], \"internal_label\": [\"id1\", \"id2\"] } Not compatible with any other targeting parameters. REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call Note: If targeting push, email, or sms subscribers with same ids, use with target_channel to indicate you are sending a push or email or sms. | [optional] |
+| **include_subscription_ids** | **Array<String>** | Specific subscription ids to target. Not compatible with other targeting parameters. | [optional] |
+| **included_segments** | **Array<String>** | Segment names to include. Only compatible with excluded_segments. | [optional] |
+| **excluded_segments** | **Array<String>** | Segment names to exclude. Only compatible with included_segments. | [optional] |
+| **filters** | [**Array<FilterExpression>**](FilterExpression.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::StartLiveActivityRequest.new(
+  name: null,
+  event: null,
+  activity_id: null,
+  event_attributes: null,
+  event_updates: null,
+  contents: null,
+  headings: null,
+  stale_date: null,
+  priority: null,
+  ios_relevance_score: null,
+  idempotency_key: null,
+  include_aliases: null,
+  include_subscription_ids: null,
+  included_segments: null,
+  excluded_segments: null,
+  filters: null
+)
+```
+

data/docs/StartLiveActivitySuccessResponse.md

@@ -0,0 +1,18 @@
+# OneSignal::StartLiveActivitySuccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **notification_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::StartLiveActivitySuccessResponse.new(
+  notification_id: null
+)
+```
+

data/docs/TemplateResource.md

@@ -0,0 +1,28 @@
+# OneSignal::TemplateResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+| **channel** | **String** |  | [optional] |
+| **content** | **Hash<String, Object>** | Rendered content and channel/platform flags for the template. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::TemplateResource.new(
+  id: null,
+  name: null,
+  created_at: null,
+  updated_at: null,
+  channel: null,
+  content: null
+)
+```
+

data/docs/TemplatesListResponse.md

@@ -0,0 +1,18 @@
+# OneSignal::TemplatesListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **templates** | [**Array<TemplateResource>**](TemplateResource.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::TemplatesListResponse.new(
+  templates: null
+)
+```
+

data/docs/UpdateApiKeyRequest.md

@@ -0,0 +1,22 @@
+# OneSignal::UpdateApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **ip_allowlist_mode** | **String** |  | [optional] |
+| **ip_allowlist** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::UpdateApiKeyRequest.new(
+  name: null,
+  ip_allowlist_mode: null,
+  ip_allowlist: null
+)
+```
+

data/docs/UpdateTemplateRequest.md

@@ -0,0 +1,30 @@
+# OneSignal::UpdateTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Updated name of the template. | [optional] |
+| **contents** | [**LanguageStringMap**](LanguageStringMap.md) |  | [optional] |
+| **is_email** | **Boolean** | Set true for an Email template. | [optional] |
+| **email_subject** | **String** | Subject of the email. | [optional] |
+| **email_body** | **String** | Body of the email (HTML supported). | [optional] |
+| **is_sms** | **Boolean** | Set true for an SMS template. | [optional] |
+| **dynamic_content** | **String** | JSON string for dynamic content personalization. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::UpdateTemplateRequest.new(
+  name: null,
+  contents: null,
+  is_email: null,
+  email_subject: null,
+  email_body: null,
+  is_sms: null,
+  dynamic_content: null
+)
+```
+