Skip to content

Commit bfca704

Browse files
author
OneSignal
committed
Update Ruby API
1 parent 85563c8 commit bfca704

33 files changed

+4582
-1722
lines changed

docs/BasicNotification.md

+240
Large diffs are not rendered by default.

docs/BasicNotificationAllOf.md

+192
Large diffs are not rendered by default.

docs/NotificationAllOfAndroidBackgroundLayout.md renamed to docs/BasicNotificationAllOfAndroidBackgroundLayout.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OneSignal::NotificationAllOfAndroidBackgroundLayout
1+
# OneSignal::BasicNotificationAllOfAndroidBackgroundLayout
22

33
## Properties
44

@@ -13,7 +13,7 @@
1313
```ruby
1414
require 'onesignal'
1515

16-
instance = OneSignal::NotificationAllOfAndroidBackgroundLayout.new(
16+
instance = OneSignal::BasicNotificationAllOfAndroidBackgroundLayout.new(
1717
image: null,
1818
headings_color: null,
1919
contents_color: null

docs/DeletePlayerBadRequestResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7-
| **erorrs** | **Array<String>** | | [optional] |
7+
| **erorrs** | **Array<Boolean>** | | [optional] |
88

99
## Example
1010

docs/DeletePlayerNotFoundResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7-
| **success** | **String** | | [optional] |
7+
| **success** | **Boolean** | | [optional] |
88

99
## Example
1010

docs/DeletePlayerSuccessResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
7-
| **success** | **String** | | [optional] |
7+
| **success** | **Boolean** | | [optional] |
88

99
## Example
1010

docs/ExportPlayersRequestBody.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| Name | Type | Description | Notes |
66
| ---- | ---- | ----------- | ----- |
77
| **extra_fields** | **Array<String>** | Additional fields that you wish to include. Currently supports location, country, rooted, notification_types, ip, external_user_id, web_auth, and web_p256. | [optional] |
8-
| **last_active_since** | **Integer** | Export all devices with a last_active timestamp greater than this time. Unixtime in seconds. | [optional] |
8+
| **last_active_since** | **String** | Export all devices with a last_active timestamp greater than this time. Unixtime in seconds. | [optional] |
99
| **segment_name** | **String** | Export al ldevices belonging to the segment. | [optional] |
1010

1111
## Example

docs/Notification.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
| **value** | **Integer** | | [optional][readonly] |
3333
| **name** | **String** | Required for SMS Messages. An identifier for tracking message within the OneSignal dashboard or export analytics. Not shown to end user. | [optional] |
3434
| **aggregation** | **String** | | [optional][readonly] |
35-
| **is_ios** | **Boolean** | Indicates whether to send to all devices registered under your app's Apple iOS platform. | [optional][default to true] |
35+
| **is_ios** | **Boolean** | Indicates whether to send to all devices registered under your app's Apple iOS platform. | [optional] |
3636
| **is_android** | **Boolean** | Indicates whether to send to all devices registered under your app's Google Android platform. | [optional] |
3737
| **is_huawei** | **Boolean** | Indicates whether to send to all devices registered under your app's Huawei Android platform. | [optional] |
3838
| **is_any_web** | **Boolean** | Indicates whether to send to all subscribed web browser users, including Chrome, Firefox, and Safari. You may use this instead as a combined flag instead of separately enabling isChromeWeb, isFirefox, and isSafari, though the three options are equivalent to this one. | [optional] |
@@ -70,7 +70,7 @@
7070
| **huawei_channel_id** | **String** | Channel: Push Notifications Platform: Huawei The Android Oreo Notification Category to send the notification under. See the Category documentation on creating one and getting it's id. | [optional] |
7171
| **existing_android_channel_id** | **String** | Channel: Push Notifications Platform: Android Use this if you have client side Android Oreo Channels you have already defined in your app with code. | [optional] |
7272
| **huawei_existing_channel_id** | **String** | Channel: Push Notifications Platform: Huawei Use this if you have client side Android Oreo Channels you have already defined in your app with code. | [optional] |
73-
| **android_background_layout** | [**NotificationAllOfAndroidBackgroundLayout**](NotificationAllOfAndroidBackgroundLayout.md) | | [optional] |
73+
| **android_background_layout** | [**BasicNotificationAllOfAndroidBackgroundLayout**](BasicNotificationAllOfAndroidBackgroundLayout.md) | | [optional] |
7474
| **small_icon** | **String** | Channel: Push Notifications Platform: Android Icon shown in the status bar and on the top left of the notification. If not set a bell icon will be used or ic_stat_onesignal_default if you have set this resource name. See: How to create small icons | [optional] |
7575
| **huawei_small_icon** | **String** | Channel: Push Notifications Platform: Huawei Icon shown in the status bar and on the top left of the notification. Use an Android resource path (E.g. /drawable/small_icon). Defaults to your app icon if not set. | [optional] |
7676
| **large_icon** | **String** | Channel: Push Notifications Platform: Android Can be a drawable resource name or a URL. See: How to create large icons | [optional] |
@@ -97,7 +97,6 @@
9797
| **collapse_id** | **String** | Channel: Push Notifications Platform: iOS 10+, Android Only one notification with the same id will be shown on the device. Use the same id to update an existing notification instead of showing a new one. Limit of 64 characters. | [optional] |
9898
| **web_push_topic** | **String** | Channel: Push Notifications Platform: All Browsers Display multiple notifications at once with different topics. | [optional] |
9999
| **apns_alert** | **Object** | Channel: Push Notifications Platform: iOS 10+ iOS can localize push notification messages on the client using special parameters such as loc-key. When using the Create Notification endpoint, you must include these parameters inside of a field called apns_alert. Please see Apple's guide on localizing push notifications to learn more. | [optional] |
100-
| **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] |
101100
| **delayed_option** | **String** | Channel: All Possible values are: timezone (Deliver at a specific time-of-day in each users own timezone) last-active Same as Intelligent Delivery . (Deliver at the same time of day as each user last used your app). If send_after is used, this takes effect after the send_after time has elapsed. | [optional] |
102101
| **delivery_time_of_day** | **String** | Channel: All Use with delayed_option=timezone. Examples: \"9:00AM\" \"21:45\" \"9:45:30\" | [optional] |
103102
| **ttl** | **Integer** | Channel: Push Notifications Platform: iOS, Android, Chrome, Firefox, Safari, ChromeWeb Time To Live - In seconds. The notification will be expired if the device does not come back online within this time. The default is 259,200 seconds (3 days). Max value to set is 2419200 seconds (28 days). | [optional] |
@@ -117,6 +116,7 @@
117116
| **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] |
118117
| **sms_from** | **String** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional] |
119118
| **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] |
119+
| **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] |
120120

121121
## Example
122122

@@ -217,7 +217,6 @@ instance = OneSignal::Notification.new(
217217
collapse_id: null,
218218
web_push_topic: null,
219219
apns_alert: null,
220-
send_after: null,
221220
delayed_option: null,
222221
delivery_time_of_day: null,
223222
ttl: null,
@@ -236,7 +235,8 @@ instance = OneSignal::Notification.new(
236235
email_from_name: null,
237236
email_from_address: null,
238237
sms_from: null,
239-
sms_media_urls: null
238+
sms_media_urls: null,
239+
send_after: null
240240
)
241241
```
242242

0 commit comments

Comments
 (0)