Skip to content

Commit e40b1a6

Browse files
author
OneSignal
committed
feat: add v2.1.0 package updates
1 parent 9e3b8f4 commit e40b1a6

File tree

159 files changed

+242
-258
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

159 files changed

+242
-258
lines changed

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A powerful way to send personalized messages at scale and build effective custom
66

77
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
88

9-
- API version: 1.3.0
9+
- API version: 1.4.0
1010
- Package version: 2.1.0
1111
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
1212
For more information, please visit [https://onesignal.com](https://onesignal.com)
@@ -59,8 +59,6 @@ require 'onesignal'
5959

6060
# Setup authorization
6161
OneSignal.configure do |config|
62-
# Configure Bearer authorization: app_key
63-
config.access_token = 'YOUR_BEARER_TOKEN'
6462
end
6563

6664
api_instance = OneSignal::DefaultApi.new
@@ -202,9 +200,7 @@ Class | Method | HTTP request | Description
202200

203201
### app_key
204202

205-
- **Type**: Bearer authentication
206203

207204
### user_key
208205

209-
- **Type**: Bearer authentication
210206

docs/BasicNotification.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
| **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] |
3535
| **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] |
3636
| **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. | |
37-
| **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] |
37+
| **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] |
38+
| **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] |
3839
| **contents** | [**StringMap**](StringMap.md) | | [optional] |
3940
| **headings** | [**StringMap**](StringMap.md) | | [optional] |
4041
| **subtitle** | [**StringMap**](StringMap.md) | | [optional] |
@@ -148,6 +149,7 @@ instance = OneSignal::BasicNotification.new(
148149
channel_for_external_user_ids: null,
149150
app_id: null,
150151
external_id: null,
152+
idempotency_key: null,
151153
contents: null,
152154
headings: null,
153155
subtitle: null,

docs/BasicNotificationAllOf.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
| **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] |
2121
| **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] |
2222
| **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] |
23-
| **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] |
23+
| **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] |
24+
| **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] |
2425
| **contents** | [**StringMap**](StringMap.md) | | [optional] |
2526
| **headings** | [**StringMap**](StringMap.md) | | [optional] |
2627
| **subtitle** | [**StringMap**](StringMap.md) | | [optional] |
@@ -120,6 +121,7 @@ instance = OneSignal::BasicNotificationAllOf.new(
120121
channel_for_external_user_ids: null,
121122
app_id: null,
122123
external_id: null,
124+
idempotency_key: null,
123125
contents: null,
124126
headings: null,
125127
subtitle: null,

docs/DefaultApi.md

Lines changed: 0 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,6 @@ Starts a Live Activity
5757
require 'onesignal'
5858
# setup authorization
5959
OneSignal.configure do |config|
60-
# Configure Bearer authorization: app_key
61-
config.app_key = 'YOUR_BEARER_TOKEN'
6260

6361
end
6462

@@ -129,8 +127,6 @@ Used to stop a scheduled or currently outgoing notification
129127
require 'onesignal'
130128
# setup authorization
131129
OneSignal.configure do |config|
132-
# Configure Bearer authorization: app_key
133-
config.app_key = 'YOUR_BEARER_TOKEN'
134130

135131
end
136132

@@ -200,8 +196,6 @@ Creates a new OneSignal app
200196
require 'onesignal'
201197
# setup authorization
202198
OneSignal.configure do |config|
203-
# Configure Bearer authorization: user_key
204-
config.user_key = 'YOUR_BEARER_TOKEN'
205199

206200
end
207201

@@ -269,8 +263,6 @@ Sends notifications to your users
269263
require 'onesignal'
270264
# setup authorization
271265
OneSignal.configure do |config|
272-
# Configure Bearer authorization: app_key
273-
config.app_key = 'YOUR_BEARER_TOKEN'
274266

275267
end
276268

@@ -338,8 +330,6 @@ Register a new device to one of your OneSignal apps 🚧 Don't use this Thi
338330
require 'onesignal'
339331
# setup authorization
340332
OneSignal.configure do |config|
341-
# Configure Bearer authorization: app_key
342-
config.app_key = 'YOUR_BEARER_TOKEN'
343333

344334
end
345335

@@ -407,8 +397,6 @@ Create segments visible and usable in the dashboard and API - Required: OneSigna
407397
require 'onesignal'
408398
# setup authorization
409399
OneSignal.configure do |config|
410-
# Configure Bearer authorization: app_key
411-
config.app_key = 'YOUR_BEARER_TOKEN'
412400

413401
end
414402

@@ -480,8 +468,6 @@ Creates a new Subscription under the User provided. Useful to add email addresse
480468
require 'onesignal'
481469
# setup authorization
482470
OneSignal.configure do |config|
483-
# Configure Bearer authorization: app_key
484-
config.app_key = 'YOUR_BEARER_TOKEN'
485471

486472
end
487473

@@ -555,8 +541,6 @@ Creates a User, optionally Subscriptions owned by the User as well as Aliases. A
555541
require 'onesignal'
556542
# setup authorization
557543
OneSignal.configure do |config|
558-
# Configure Bearer authorization: app_key
559-
config.app_key = 'YOUR_BEARER_TOKEN'
560544

561545
end
562546

@@ -626,8 +610,6 @@ Deletes an alias by alias label
626610
require 'onesignal'
627611
# setup authorization
628612
OneSignal.configure do |config|
629-
# Configure Bearer authorization: app_key
630-
config.app_key = 'YOUR_BEARER_TOKEN'
631613

632614
end
633615

@@ -701,8 +683,6 @@ Delete player - Required: Used to delete a single, specific Player ID record fro
701683
require 'onesignal'
702684
# setup authorization
703685
OneSignal.configure do |config|
704-
# Configure Bearer authorization: app_key
705-
config.app_key = 'YOUR_BEARER_TOKEN'
706686

707687
end
708688

@@ -772,8 +752,6 @@ Delete segments (not user devices) - Required: OneSignal Paid Plan You can delet
772752
require 'onesignal'
773753
# setup authorization
774754
OneSignal.configure do |config|
775-
# Configure Bearer authorization: app_key
776-
config.app_key = 'YOUR_BEARER_TOKEN'
777755

778756
end
779757

@@ -843,8 +821,6 @@ Deletes the Subscription.
843821
require 'onesignal'
844822
# setup authorization
845823
OneSignal.configure do |config|
846-
# Configure Bearer authorization: app_key
847-
config.app_key = 'YOUR_BEARER_TOKEN'
848824

849825
end
850826

@@ -913,8 +889,6 @@ Removes the User identified by (:alias_label, :alias_id), and all Subscriptions
913889
require 'onesignal'
914890
# setup authorization
915891
OneSignal.configure do |config|
916-
# Configure Bearer authorization: app_key
917-
config.app_key = 'YOUR_BEARER_TOKEN'
918892

919893
end
920894

@@ -985,8 +959,6 @@ Stops a Live Activity
985959
require 'onesignal'
986960
# setup authorization
987961
OneSignal.configure do |config|
988-
# Configure Bearer authorization: app_key
989-
config.app_key = 'YOUR_BEARER_TOKEN'
990962

991963
end
992964

@@ -1057,8 +1029,6 @@ Generate a compressed CSV report of all of the events data for a notification. T
10571029
require 'onesignal'
10581030
# setup authorization
10591031
OneSignal.configure do |config|
1060-
# Configure Bearer authorization: app_key
1061-
config.app_key = 'YOUR_BEARER_TOKEN'
10621032

10631033
end
10641034

@@ -1128,8 +1098,6 @@ Generate a compressed CSV export of all of your current user data This method ca
11281098
require 'onesignal'
11291099
# setup authorization
11301100
OneSignal.configure do |config|
1131-
# Configure Bearer authorization: app_key
1132-
config.app_key = 'YOUR_BEARER_TOKEN'
11331101

11341102
end
11351103

@@ -1201,8 +1169,6 @@ Lists all Aliases for the User identified by :subscription_id.
12011169
require 'onesignal'
12021170
# setup authorization
12031171
OneSignal.configure do |config|
1204-
# Configure Bearer authorization: app_key
1205-
config.app_key = 'YOUR_BEARER_TOKEN'
12061172

12071173
end
12081174

@@ -1272,8 +1238,6 @@ Returns the User’s properties, Aliases, and Subscriptions.
12721238
require 'onesignal'
12731239
# setup authorization
12741240
OneSignal.configure do |config|
1275-
# Configure Bearer authorization: app_key
1276-
config.app_key = 'YOUR_BEARER_TOKEN'
12771241

12781242
end
12791243

@@ -1345,8 +1309,6 @@ Lists all Aliases for the User identified by (:alias_label, :alias_id).
13451309
require 'onesignal'
13461310
# setup authorization
13471311
OneSignal.configure do |config|
1348-
# Configure Bearer authorization: app_key
1349-
config.app_key = 'YOUR_BEARER_TOKEN'
13501312

13511313
end
13521314

@@ -1418,8 +1380,6 @@ View the details of a single OneSignal app
14181380
require 'onesignal'
14191381
# setup authorization
14201382
OneSignal.configure do |config|
1421-
# Configure Bearer authorization: user_key
1422-
config.user_key = 'YOUR_BEARER_TOKEN'
14231383

14241384
end
14251385

@@ -1487,8 +1447,6 @@ View the details of all of your current OneSignal apps
14871447
require 'onesignal'
14881448
# setup authorization
14891449
OneSignal.configure do |config|
1490-
# Configure Bearer authorization: user_key
1491-
config.user_key = 'YOUR_BEARER_TOKEN'
14921450

14931451
end
14941452

@@ -1553,8 +1511,6 @@ Manifest of In-App Messages the Subscription is eligible to display by the SDK.
15531511
require 'onesignal'
15541512
# setup authorization
15551513
OneSignal.configure do |config|
1556-
# Configure Bearer authorization: app_key
1557-
config.app_key = 'YOUR_BEARER_TOKEN'
15581514

15591515
end
15601516

@@ -1624,8 +1580,6 @@ View the details of a single notification and outcomes associated with it
16241580
require 'onesignal'
16251581
# setup authorization
16261582
OneSignal.configure do |config|
1627-
# Configure Bearer authorization: app_key
1628-
config.app_key = 'YOUR_BEARER_TOKEN'
16291583

16301584
end
16311585

@@ -1695,8 +1649,6 @@ Notification History
16951649
require 'onesignal'
16961650
# setup authorization
16971651
OneSignal.configure do |config|
1698-
# Configure Bearer authorization: app_key
1699-
config.app_key = 'YOUR_BEARER_TOKEN'
17001652

17011653
end
17021654

@@ -1766,8 +1718,6 @@ View the details of multiple notifications
17661718
require 'onesignal'
17671719
# setup authorization
17681720
OneSignal.configure do |config|
1769-
# Configure Bearer authorization: app_key
1770-
config.app_key = 'YOUR_BEARER_TOKEN'
17711721

17721722
end
17731723

@@ -1843,8 +1793,6 @@ View the details of all the outcomes associated with your app 🚧 Require
18431793
require 'onesignal'
18441794
# setup authorization
18451795
OneSignal.configure do |config|
1846-
# Configure Bearer authorization: app_key
1847-
config.app_key = 'YOUR_BEARER_TOKEN'
18481796

18491797
end
18501798

@@ -1924,8 +1872,6 @@ View the details of an existing device in one of your OneSignal apps
19241872
require 'onesignal'
19251873
# setup authorization
19261874
OneSignal.configure do |config|
1927-
# Configure Bearer authorization: app_key
1928-
config.app_key = 'YOUR_BEARER_TOKEN'
19291875

19301876
end
19311877

@@ -1999,8 +1945,6 @@ View the details of multiple devices in one of your OneSignal apps Unavailable f
19991945
require 'onesignal'
20001946
# setup authorization
20011947
OneSignal.configure do |config|
2002-
# Configure Bearer authorization: app_key
2003-
config.app_key = 'YOUR_BEARER_TOKEN'
20041948

20051949
end
20061950

@@ -2074,8 +2018,6 @@ Upserts one or more Aliases to an existing User identified by (:alias_label, :al
20742018
require 'onesignal'
20752019
# setup authorization
20762020
OneSignal.configure do |config|
2077-
# Configure Bearer authorization: app_key
2078-
config.app_key = 'YOUR_BEARER_TOKEN'
20792021

20802022
end
20812023

@@ -2149,8 +2091,6 @@ Upserts one or more Aliases for the User identified by :subscription_id.
21492091
require 'onesignal'
21502092
# setup authorization
21512093
OneSignal.configure do |config|
2152-
# Configure Bearer authorization: app_key
2153-
config.app_key = 'YOUR_BEARER_TOKEN'
21542094

21552095
end
21562096

@@ -2222,8 +2162,6 @@ Transfers this Subscription to the User identified by the identity in the payloa
22222162
require 'onesignal'
22232163
# setup authorization
22242164
OneSignal.configure do |config|
2225-
# Configure Bearer authorization: app_key
2226-
config.app_key = 'YOUR_BEARER_TOKEN'
22272165

22282166
end
22292167

@@ -2295,8 +2233,6 @@ Updates the name or configuration settings of an existing OneSignal app
22952233
require 'onesignal'
22962234
# setup authorization
22972235
OneSignal.configure do |config|
2298-
# Configure Bearer authorization: user_key
2299-
config.user_key = 'YOUR_BEARER_TOKEN'
23002236

23012237
end
23022238

@@ -2366,8 +2302,6 @@ Updates a specified live activity.
23662302
require 'onesignal'
23672303
# setup authorization
23682304
OneSignal.configure do |config|
2369-
# Configure Bearer authorization: app_key
2370-
config.app_key = 'YOUR_BEARER_TOKEN'
23712305

23722306
end
23732307

@@ -2439,8 +2373,6 @@ Update an existing device in one of your OneSignal apps
24392373
require 'onesignal'
24402374
# setup authorization
24412375
OneSignal.configure do |config|
2442-
# Configure Bearer authorization: app_key
2443-
config.app_key = 'YOUR_BEARER_TOKEN'
24442376

24452377
end
24462378

@@ -2510,8 +2442,6 @@ Update an existing device's tags in one of your OneSignal apps using the Externa
25102442
require 'onesignal'
25112443
# setup authorization
25122444
OneSignal.configure do |config|
2513-
# Configure Bearer authorization: app_key
2514-
config.app_key = 'YOUR_BEARER_TOKEN'
25152445

25162446
end
25172447

@@ -2585,8 +2515,6 @@ Updates an existing Subscription’s properties.
25852515
require 'onesignal'
25862516
# setup authorization
25872517
OneSignal.configure do |config|
2588-
# Configure Bearer authorization: app_key
2589-
config.app_key = 'YOUR_BEARER_TOKEN'
25902518

25912519
end
25922520

@@ -2657,8 +2585,6 @@ Updates an existing User’s properties.
26572585
require 'onesignal'
26582586
# setup authorization
26592587
OneSignal.configure do |config|
2660-
# Configure Bearer authorization: app_key
2661-
config.app_key = 'YOUR_BEARER_TOKEN'
26622588

26632589
end
26642590

0 commit comments

Comments
 (0)