onesignal 2.2.1 → 5.1.0.pre.beta1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +42 -67
- data/docs/BasicNotification.md +18 -18
- data/docs/BasicNotificationAllOf.md +9 -7
- data/docs/CreateNotificationSuccessResponse.md +1 -3
- data/docs/DefaultApi.md +364 -948
- data/docs/{ExportPlayersRequestBody.md → ExportSubscriptionsRequestBody.md} +2 -2
- data/docs/{ExportPlayersSuccessResponse.md → ExportSubscriptionsSuccessResponse.md} +2 -2
- data/docs/Filter.md +10 -2
- data/docs/{Notification200Errors.md → FilterExpression.md} +9 -9
- data/docs/GenericError.md +6 -2
- data/docs/{DeletePlayerSuccessResponse.md → GenericSuccessBoolResponse.md} +2 -2
- data/docs/{GetNotificationRequestBody.md → GetNotificationHistoryRequestBody.md} +2 -2
- data/docs/GetSegmentsSuccessResponse.md +24 -0
- data/docs/{StringMap.md → LanguageStringMap.md} +2 -2
- data/docs/Notification.md +18 -18
- data/docs/NotificationTarget.md +9 -11
- data/docs/NotificationWithMeta.md +18 -18
- data/docs/{InlineResponse202.md → PropertiesBody.md} +2 -2
- data/docs/PropertiesDeltas.md +2 -2
- data/docs/PropertiesObject.md +2 -2
- data/docs/Purchase.md +1 -1
- data/docs/RateLimitError.md +20 -0
- data/docs/Segment.md +1 -1
- data/docs/SegmentData.md +30 -0
- data/docs/{SubscriptionObject.md → Subscription.md} +6 -6
- data/docs/SubscriptionBody.md +18 -0
- data/docs/SubscriptionNotificationTarget.md +38 -0
- data/docs/TransferSubscriptionRequestBody.md +1 -1
- data/docs/UpdateLiveActivityRequest.md +14 -4
- data/docs/UpdateLiveActivitySuccessResponse.md +2 -4
- data/docs/User.md +3 -5
- data/docs/{InlineResponse200.md → UserIdentityBody.md} +3 -3
- data/docs/WebButton.md +24 -0
- data/lib/onesignal/api/default_api.rb +382 -890
- data/lib/onesignal/api_client.rb +2 -2
- data/lib/onesignal/api_error.rb +1 -1
- data/lib/onesignal/configuration.rb +5 -5
- data/lib/onesignal/models/app.rb +1 -1
- data/lib/onesignal/models/basic_notification.rb +49 -47
- data/lib/onesignal/models/basic_notification_all_of.rb +29 -17
- data/lib/onesignal/models/basic_notification_all_of_android_background_layout.rb +1 -1
- data/lib/onesignal/models/button.rb +1 -1
- data/lib/onesignal/models/create_notification_success_response.rb +5 -13
- data/lib/onesignal/models/create_segment_conflict_response.rb +1 -1
- data/lib/onesignal/models/create_segment_success_response.rb +1 -1
- data/lib/onesignal/models/create_user_conflict_response.rb +1 -1
- data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +1 -1
- data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +1 -1
- data/lib/onesignal/models/delivery_data.rb +1 -1
- data/lib/onesignal/models/export_events_success_response.rb +1 -1
- data/lib/onesignal/models/{export_players_request_body.rb → export_subscriptions_request_body.rb} +4 -4
- data/lib/onesignal/models/{export_players_success_response.rb → export_subscriptions_success_response.rb} +4 -4
- data/lib/onesignal/models/filter.rb +44 -14
- data/lib/onesignal/models/{notification200_errors.rb → filter_expression.rb} +4 -4
- data/lib/onesignal/models/generic_error.rb +26 -8
- data/lib/onesignal/models/{update_player_success_response.rb → generic_success_bool_response.rb} +4 -4
- data/lib/onesignal/models/{get_notification_request_body.rb → get_notification_history_request_body.rb} +4 -4
- data/lib/onesignal/models/{player_slice.rb → get_segments_success_response.rb} +16 -12
- data/lib/onesignal/models/{string_map.rb → language_string_map.rb} +4 -4
- data/lib/onesignal/models/notification.rb +49 -47
- data/lib/onesignal/models/notification_all_of.rb +1 -1
- data/lib/onesignal/models/notification_history_success_response.rb +1 -1
- data/lib/onesignal/models/notification_slice.rb +1 -1
- data/lib/onesignal/models/notification_target.rb +24 -34
- data/lib/onesignal/models/notification_with_meta.rb +49 -47
- data/lib/onesignal/models/notification_with_meta_all_of.rb +1 -1
- data/lib/onesignal/models/operator.rb +1 -1
- data/lib/onesignal/models/outcome_data.rb +1 -1
- data/lib/onesignal/models/outcomes_data.rb +1 -1
- data/lib/onesignal/models/platform_delivery_data.rb +1 -1
- data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +1 -1
- data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +1 -1
- data/lib/onesignal/models/{inline_response202.rb → properties_body.rb} +4 -4
- data/lib/onesignal/models/properties_deltas.rb +3 -3
- data/lib/onesignal/models/properties_object.rb +3 -3
- data/lib/onesignal/models/purchase.rb +2 -2
- data/lib/onesignal/models/{rate_limiter_error.rb → rate_limit_error.rb} +17 -8
- data/lib/onesignal/models/segment.rb +2 -2
- data/lib/onesignal/models/{begin_live_activity_request.rb → segment_data.rb} +69 -27
- data/lib/onesignal/models/segment_notification_target.rb +1 -1
- data/lib/onesignal/models/{subscription_object.rb → subscription.rb} +8 -8
- data/lib/onesignal/models/{inline_response201.rb → subscription_body.rb} +5 -5
- data/lib/onesignal/models/{player_notification_target.rb → subscription_notification_target.rb} +25 -35
- data/lib/onesignal/models/transfer_subscription_request_body.rb +26 -2
- data/lib/onesignal/models/update_live_activity_request.rb +59 -22
- data/lib/onesignal/models/update_live_activity_success_response.rb +8 -17
- data/lib/onesignal/models/update_user_request.rb +1 -1
- data/lib/onesignal/models/user.rb +6 -15
- data/lib/onesignal/models/{inline_response200.rb → user_identity_body.rb} +5 -5
- data/lib/onesignal/models/{create_player_success_response.rb → web_button.rb} +40 -17
- data/lib/onesignal/version.rb +2 -2
- data/lib/onesignal.rb +16 -34
- data/onesignal.gemspec +1 -1
- data/spec/api/default_api_spec.rb +82 -174
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/app_spec.rb +1 -1
- data/spec/models/basic_notification_all_of_android_background_layout_spec.rb +1 -1
- data/spec/models/basic_notification_all_of_spec.rb +13 -7
- data/spec/models/basic_notification_spec.rb +14 -14
- data/spec/models/button_spec.rb +1 -1
- data/spec/models/create_notification_success_response_spec.rb +1 -7
- data/spec/models/create_segment_conflict_response_spec.rb +1 -1
- data/spec/models/create_segment_success_response_spec.rb +1 -1
- data/spec/models/create_user_conflict_response_errors_inner_spec.rb +1 -1
- data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +1 -1
- data/spec/models/create_user_conflict_response_spec.rb +1 -1
- data/spec/models/delivery_data_spec.rb +1 -1
- data/spec/models/export_events_success_response_spec.rb +1 -1
- data/spec/models/{export_players_request_body_spec.rb → export_subscriptions_request_body_spec.rb} +7 -7
- data/spec/models/{export_players_success_response_spec.rb → export_subscriptions_success_response_spec.rb} +7 -7
- data/spec/models/{notification200_errors_spec.rb → filter_expression_spec.rb} +3 -3
- data/spec/models/filter_spec.rb +25 -1
- data/spec/models/generic_error_spec.rb +13 -1
- data/spec/models/{delete_player_success_response_spec.rb → generic_success_bool_response_spec.rb} +7 -7
- data/spec/models/{get_notification_request_body_spec.rb → get_notification_history_request_body_spec.rb} +7 -7
- data/spec/models/{player_slice_spec.rb → get_segments_success_response_spec.rb} +8 -8
- data/spec/models/{string_map_spec.rb → language_string_map_spec.rb} +7 -7
- data/spec/models/notification_all_of_spec.rb +1 -1
- data/spec/models/notification_history_success_response_spec.rb +1 -1
- data/spec/models/notification_slice_spec.rb +1 -1
- data/spec/models/notification_spec.rb +14 -14
- data/spec/models/notification_target_spec.rb +2 -8
- data/spec/models/notification_with_meta_all_of_spec.rb +1 -1
- data/spec/models/notification_with_meta_spec.rb +14 -14
- data/spec/models/operator_spec.rb +1 -1
- data/spec/models/outcome_data_spec.rb +1 -1
- data/spec/models/outcomes_data_spec.rb +1 -1
- data/spec/models/platform_delivery_data_email_all_of_spec.rb +1 -1
- data/spec/models/platform_delivery_data_sms_all_of_spec.rb +1 -1
- data/spec/models/platform_delivery_data_spec.rb +1 -1
- data/spec/models/{inline_response202_spec.rb → properties_body_spec.rb} +7 -7
- data/spec/models/properties_deltas_spec.rb +1 -1
- data/spec/models/properties_object_spec.rb +1 -1
- data/spec/models/purchase_spec.rb +1 -1
- data/spec/models/{generic_error_errors_inner_spec.rb → rate_limit_error_spec.rb} +9 -9
- data/spec/models/{filter_expressions_spec.rb → segment_data_spec.rb} +24 -20
- data/spec/models/segment_notification_target_spec.rb +1 -1
- data/spec/models/segment_spec.rb +1 -1
- data/spec/models/{inline_response201_spec.rb → subscription_body_spec.rb} +7 -7
- data/spec/models/{player_notification_target_spec.rb → subscription_notification_target_spec.rb} +8 -14
- data/spec/models/{subscription_object_spec.rb → subscription_spec.rb} +7 -7
- data/spec/models/transfer_subscription_request_body_spec.rb +1 -1
- data/spec/models/update_live_activity_request_spec.rb +32 -6
- data/spec/models/update_live_activity_success_response_spec.rb +2 -8
- data/spec/models/update_user_request_spec.rb +1 -1
- data/spec/models/{user_identity_response_spec.rb → user_identity_body_spec.rb} +7 -7
- data/spec/models/user_spec.rb +1 -7
- data/spec/models/{create_player_success_response_spec.rb → web_button_spec.rb} +21 -9
- data/spec/spec_helper.rb +1 -1
- metadata +61 -131
- data/docs/BeginLiveActivityRequest.md +0 -20
- data/docs/CancelNotificationSuccessResponse.md +0 -18
- data/docs/CreatePlayerSuccessResponse.md +0 -20
- data/docs/CreateSubscriptionRequestBody.md +0 -20
- data/docs/DeletePlayerNotFoundResponse.md +0 -18
- data/docs/DeleteSegmentNotFoundResponse.md +0 -18
- data/docs/DeleteSegmentSuccessResponse.md +0 -18
- data/docs/FilterExpressions.md +0 -26
- data/docs/InlineResponse2003.md +0 -18
- data/docs/InlineResponse201.md +0 -18
- data/docs/InvalidIdentifierError.md +0 -20
- data/docs/Player.md +0 -70
- data/docs/PlayerNotificationTarget.md +0 -40
- data/docs/PlayerNotificationTargetIncludeAliases.md +0 -18
- data/docs/PlayerSlice.md +0 -24
- data/docs/UpdatePlayerSuccessResponse.md +0 -18
- data/docs/UpdatePlayerTagsRequestBody.md +0 -18
- data/docs/UpdatePlayerTagsSuccessResponse.md +0 -18
- data/docs/UpdateSubscriptionRequestBody.md +0 -18
- data/docs/UserIdentityRequestBody.md +0 -18
- data/docs/UserIdentityResponse.md +0 -18
- data/docs/UserSubscriptionOptions.md +0 -18
- data/lib/onesignal/models/cancel_notification_success_response.rb +0 -219
- data/lib/onesignal/models/create_subscription_request_body.rb +0 -228
- data/lib/onesignal/models/delete_player_not_found_response.rb +0 -219
- data/lib/onesignal/models/delete_player_success_response.rb +0 -219
- data/lib/onesignal/models/delete_segment_not_found_response.rb +0 -219
- data/lib/onesignal/models/delete_segment_success_response.rb +0 -219
- data/lib/onesignal/models/filter_expressions.rb +0 -336
- data/lib/onesignal/models/generic_error_errors_inner.rb +0 -228
- data/lib/onesignal/models/inline_response2003.rb +0 -221
- data/lib/onesignal/models/invalid_identifier_error.rb +0 -234
- data/lib/onesignal/models/player.rb +0 -494
- data/lib/onesignal/models/player_notification_target_include_aliases.rb +0 -221
- data/lib/onesignal/models/update_player_tags_request_body.rb +0 -220
- data/lib/onesignal/models/update_player_tags_success_response.rb +0 -219
- data/lib/onesignal/models/update_subscription_request_body.rb +0 -219
- data/lib/onesignal/models/user_identity_request_body.rb +0 -221
- data/lib/onesignal/models/user_identity_response.rb +0 -221
- data/lib/onesignal/models/user_subscription_options.rb +0 -219
- data/spec/models/begin_live_activity_request_spec.rb +0 -40
- data/spec/models/cancel_notification_success_response_spec.rb +0 -34
- data/spec/models/create_subscription_request_body_spec.rb +0 -40
- data/spec/models/delete_player_not_found_response_spec.rb +0 -34
- data/spec/models/delete_segment_not_found_response_spec.rb +0 -34
- data/spec/models/delete_segment_success_response_spec.rb +0 -34
- data/spec/models/inline_response2003_spec.rb +0 -34
- data/spec/models/inline_response200_spec.rb +0 -34
- data/spec/models/invalid_identifier_error_spec.rb +0 -40
- data/spec/models/player_notification_target_include_aliases_spec.rb +0 -34
- data/spec/models/player_spec.rb +0 -190
- data/spec/models/rate_limiter_error_spec.rb +0 -34
- data/spec/models/update_player_success_response_spec.rb +0 -34
- data/spec/models/update_player_tags_request_body_spec.rb +0 -34
- data/spec/models/update_player_tags_success_response_spec.rb +0 -34
- data/spec/models/update_subscription_request_body_spec.rb +0 -34
- data/spec/models/user_identity_request_body_spec.rb +0 -34
- data/spec/models/user_subscription_options_spec.rb +0 -34
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.
|
6
|
+
The version of the OpenAPI document: 5.1.0
|
7
7
|
Contact: devrel@onesignal.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
@@ -21,11 +21,8 @@ module OneSignal
|
|
21
21
|
# Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\"Active Users\", \"Inactive Users\"]
|
22
22
|
attr_accessor :excluded_segments
|
23
23
|
|
24
|
-
# Specific
|
25
|
-
attr_accessor :
|
26
|
-
|
27
|
-
# Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [\"custom-id-assigned-by-api\"] 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 channel_for_external_user_ids to indicate you are sending a push or email or sms.
|
28
|
-
attr_accessor :include_external_user_ids
|
24
|
+
# Specific subscription ids to send your notification to. _Does not require API Auth Key._ Not compatible with any other targeting parameters. Example: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call
|
25
|
+
attr_accessor :include_subscription_ids
|
29
26
|
|
30
27
|
# Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: nick@catfac.ts Limit of 2,000 entries per REST API call
|
31
28
|
attr_accessor :include_email_tokens
|
@@ -33,24 +30,25 @@ module OneSignal
|
|
33
30
|
# Recommended for Sending SMS - Target specific phone numbers. The phone number should be in the E.164 format. Phone number should be an existing subscriber on OneSignal. Refer our docs to learn how to add phone numbers to OneSignal. Example phone number: +1999999999 Limit of 2,000 entries per REST API call
|
34
31
|
attr_accessor :include_phone_numbers
|
35
32
|
|
36
|
-
# Not Recommended: Please consider using
|
33
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call
|
37
34
|
attr_accessor :include_ios_tokens
|
38
35
|
|
39
|
-
# Not Recommended: Please consider using
|
36
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call
|
40
37
|
attr_accessor :include_wp_wns_uris
|
41
38
|
|
42
|
-
# Not Recommended: Please consider using
|
39
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call
|
43
40
|
attr_accessor :include_amazon_reg_ids
|
44
41
|
|
45
|
-
# Not Recommended: Please consider using
|
42
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
|
46
43
|
attr_accessor :include_chrome_reg_ids
|
47
44
|
|
48
|
-
# Not Recommended: Please consider using
|
45
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
|
49
46
|
attr_accessor :include_chrome_web_reg_ids
|
50
47
|
|
51
|
-
# Not Recommended: Please consider using
|
48
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
|
52
49
|
attr_accessor :include_android_reg_ids
|
53
50
|
|
51
|
+
# 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.
|
54
52
|
attr_accessor :include_aliases
|
55
53
|
|
56
54
|
attr_accessor :target_channel
|
@@ -94,9 +92,6 @@ module OneSignal
|
|
94
92
|
# 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.
|
95
93
|
attr_accessor :is_chrome
|
96
94
|
|
97
|
-
# 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.
|
98
|
-
attr_accessor :channel_for_external_user_ids
|
99
|
-
|
100
95
|
# 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.
|
101
96
|
attr_accessor :app_id
|
102
97
|
|
@@ -297,6 +292,12 @@ module OneSignal
|
|
297
292
|
# Channel: Push Notifications Platform: iOS 12+ When using thread_id, you can also control the count of the number of notifications in the group. For example, if the group already has 12 notifications, and you send a new notification with summary_arg_count = 2, the new total will be 14 and the summary will be \"14 more notifications from summary_arg\"
|
298
293
|
attr_accessor :summary_arg_count
|
299
294
|
|
295
|
+
# Channel: Push Notifications Platform: iOS 15+ A score to be set per notification to indicate how it should be displayed when grouped. Use a float between 0-1.
|
296
|
+
attr_accessor :ios_relevance_score
|
297
|
+
|
298
|
+
# Channel: Push Notifications Platform: iOS 15+ Focus Modes and Interruption Levels indicate the priority and delivery timing of a notification, to \"interrupt\" the user. Can choose from options: ['active', 'passive', 'time_sensitive', 'critical']. Default is active.
|
299
|
+
attr_accessor :ios_interruption_level
|
300
|
+
|
300
301
|
# Channel: Email Required. The subject of the email.
|
301
302
|
attr_accessor :email_subject
|
302
303
|
|
@@ -356,8 +357,7 @@ module OneSignal
|
|
356
357
|
{
|
357
358
|
:'included_segments' => :'included_segments',
|
358
359
|
:'excluded_segments' => :'excluded_segments',
|
359
|
-
:'
|
360
|
-
:'include_external_user_ids' => :'include_external_user_ids',
|
360
|
+
:'include_subscription_ids' => :'include_subscription_ids',
|
361
361
|
:'include_email_tokens' => :'include_email_tokens',
|
362
362
|
:'include_phone_numbers' => :'include_phone_numbers',
|
363
363
|
:'include_ios_tokens' => :'include_ios_tokens',
|
@@ -382,7 +382,6 @@ module OneSignal
|
|
382
382
|
:'is_wp_wns' => :'isWP_WNS',
|
383
383
|
:'is_adm' => :'isAdm',
|
384
384
|
:'is_chrome' => :'isChrome',
|
385
|
-
:'channel_for_external_user_ids' => :'channel_for_external_user_ids',
|
386
385
|
:'app_id' => :'app_id',
|
387
386
|
:'external_id' => :'external_id',
|
388
387
|
:'idempotency_key' => :'idempotency_key',
|
@@ -451,6 +450,8 @@ module OneSignal
|
|
451
450
|
:'thread_id' => :'thread_id',
|
452
451
|
:'summary_arg' => :'summary_arg',
|
453
452
|
:'summary_arg_count' => :'summary_arg_count',
|
453
|
+
:'ios_relevance_score' => :'ios_relevance_score',
|
454
|
+
:'ios_interruption_level' => :'ios_interruption_level',
|
454
455
|
:'email_subject' => :'email_subject',
|
455
456
|
:'email_body' => :'email_body',
|
456
457
|
:'email_from_name' => :'email_from_name',
|
@@ -475,8 +476,7 @@ module OneSignal
|
|
475
476
|
{
|
476
477
|
:'included_segments' => :'Array<String>',
|
477
478
|
:'excluded_segments' => :'Array<String>',
|
478
|
-
:'
|
479
|
-
:'include_external_user_ids' => :'Array<String>',
|
479
|
+
:'include_subscription_ids' => :'Array<String>',
|
480
480
|
:'include_email_tokens' => :'Array<String>',
|
481
481
|
:'include_phone_numbers' => :'Array<String>',
|
482
482
|
:'include_ios_tokens' => :'Array<String>',
|
@@ -485,7 +485,7 @@ module OneSignal
|
|
485
485
|
:'include_chrome_reg_ids' => :'Array<String>',
|
486
486
|
:'include_chrome_web_reg_ids' => :'Array<String>',
|
487
487
|
:'include_android_reg_ids' => :'Array<String>',
|
488
|
-
:'include_aliases' => :'
|
488
|
+
:'include_aliases' => :'Hash<String, Array<String>>',
|
489
489
|
:'target_channel' => :'String',
|
490
490
|
:'id' => :'String',
|
491
491
|
:'value' => :'Integer',
|
@@ -501,13 +501,12 @@ module OneSignal
|
|
501
501
|
:'is_wp_wns' => :'Boolean',
|
502
502
|
:'is_adm' => :'Boolean',
|
503
503
|
:'is_chrome' => :'Boolean',
|
504
|
-
:'channel_for_external_user_ids' => :'String',
|
505
504
|
:'app_id' => :'String',
|
506
505
|
:'external_id' => :'String',
|
507
506
|
:'idempotency_key' => :'String',
|
508
|
-
:'contents' => :'
|
509
|
-
:'headings' => :'
|
510
|
-
:'subtitle' => :'
|
507
|
+
:'contents' => :'LanguageStringMap',
|
508
|
+
:'headings' => :'LanguageStringMap',
|
509
|
+
:'subtitle' => :'LanguageStringMap',
|
511
510
|
:'data' => :'Object',
|
512
511
|
:'huawei_msg_type' => :'String',
|
513
512
|
:'url' => :'String',
|
@@ -524,7 +523,7 @@ module OneSignal
|
|
524
523
|
:'chrome_big_picture' => :'String',
|
525
524
|
:'chrome_web_image' => :'String',
|
526
525
|
:'buttons' => :'Array<Button>',
|
527
|
-
:'web_buttons' => :'Array<
|
526
|
+
:'web_buttons' => :'Array<WebButton>',
|
528
527
|
:'ios_category' => :'String',
|
529
528
|
:'android_channel_id' => :'String',
|
530
529
|
:'huawei_channel_id' => :'String',
|
@@ -570,6 +569,8 @@ module OneSignal
|
|
570
569
|
:'thread_id' => :'String',
|
571
570
|
:'summary_arg' => :'String',
|
572
571
|
:'summary_arg_count' => :'Integer',
|
572
|
+
:'ios_relevance_score' => :'Float',
|
573
|
+
:'ios_interruption_level' => :'String',
|
573
574
|
:'email_subject' => :'String',
|
574
575
|
:'email_body' => :'String',
|
575
576
|
:'email_from_name' => :'String',
|
@@ -578,7 +579,7 @@ module OneSignal
|
|
578
579
|
:'include_unsubscribed' => :'Boolean',
|
579
580
|
:'sms_from' => :'String',
|
580
581
|
:'sms_media_urls' => :'Array<String>',
|
581
|
-
:'filters' => :'Array<
|
582
|
+
:'filters' => :'Array<FilterExpression>',
|
582
583
|
:'custom_data' => :'Object',
|
583
584
|
:'send_after' => :'Time'
|
584
585
|
}
|
@@ -587,8 +588,7 @@ module OneSignal
|
|
587
588
|
# List of attributes with nullable: true
|
588
589
|
def self.openapi_nullable
|
589
590
|
Set.new([
|
590
|
-
:'
|
591
|
-
:'include_external_user_ids',
|
591
|
+
:'include_subscription_ids',
|
592
592
|
:'include_aliases',
|
593
593
|
:'name',
|
594
594
|
:'is_ios',
|
@@ -660,6 +660,8 @@ module OneSignal
|
|
660
660
|
:'adm_group',
|
661
661
|
:'adm_group_message',
|
662
662
|
:'thread_id',
|
663
|
+
:'ios_relevance_score',
|
664
|
+
:'ios_interruption_level',
|
663
665
|
:'email_subject',
|
664
666
|
:'email_from_name',
|
665
667
|
:'email_from_address',
|
@@ -707,15 +709,9 @@ module OneSignal
|
|
707
709
|
end
|
708
710
|
end
|
709
711
|
|
710
|
-
if attributes.key?(:'
|
711
|
-
if (value = attributes[:'
|
712
|
-
self.
|
713
|
-
end
|
714
|
-
end
|
715
|
-
|
716
|
-
if attributes.key?(:'include_external_user_ids')
|
717
|
-
if (value = attributes[:'include_external_user_ids']).is_a?(Array)
|
718
|
-
self.include_external_user_ids = value
|
712
|
+
if attributes.key?(:'include_subscription_ids')
|
713
|
+
if (value = attributes[:'include_subscription_ids']).is_a?(Array)
|
714
|
+
self.include_subscription_ids = value
|
719
715
|
end
|
720
716
|
end
|
721
717
|
|
@@ -768,7 +764,9 @@ module OneSignal
|
|
768
764
|
end
|
769
765
|
|
770
766
|
if attributes.key?(:'include_aliases')
|
771
|
-
|
767
|
+
if (value = attributes[:'include_aliases']).is_a?(Hash)
|
768
|
+
self.include_aliases = value
|
769
|
+
end
|
772
770
|
end
|
773
771
|
|
774
772
|
if attributes.key?(:'target_channel')
|
@@ -831,10 +829,6 @@ module OneSignal
|
|
831
829
|
self.is_chrome = attributes[:'is_chrome']
|
832
830
|
end
|
833
831
|
|
834
|
-
if attributes.key?(:'channel_for_external_user_ids')
|
835
|
-
self.channel_for_external_user_ids = attributes[:'channel_for_external_user_ids']
|
836
|
-
end
|
837
|
-
|
838
832
|
if attributes.key?(:'app_id')
|
839
833
|
self.app_id = attributes[:'app_id']
|
840
834
|
end
|
@@ -1111,6 +1105,14 @@ module OneSignal
|
|
1111
1105
|
self.summary_arg_count = attributes[:'summary_arg_count']
|
1112
1106
|
end
|
1113
1107
|
|
1108
|
+
if attributes.key?(:'ios_relevance_score')
|
1109
|
+
self.ios_relevance_score = attributes[:'ios_relevance_score']
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
if attributes.key?(:'ios_interruption_level')
|
1113
|
+
self.ios_interruption_level = attributes[:'ios_interruption_level']
|
1114
|
+
end
|
1115
|
+
|
1114
1116
|
if attributes.key?(:'email_subject')
|
1115
1117
|
self.email_subject = attributes[:'email_subject']
|
1116
1118
|
end
|
@@ -1209,8 +1211,7 @@ module OneSignal
|
|
1209
1211
|
self.class == o.class &&
|
1210
1212
|
included_segments == o.included_segments &&
|
1211
1213
|
excluded_segments == o.excluded_segments &&
|
1212
|
-
|
1213
|
-
include_external_user_ids == o.include_external_user_ids &&
|
1214
|
+
include_subscription_ids == o.include_subscription_ids &&
|
1214
1215
|
include_email_tokens == o.include_email_tokens &&
|
1215
1216
|
include_phone_numbers == o.include_phone_numbers &&
|
1216
1217
|
include_ios_tokens == o.include_ios_tokens &&
|
@@ -1235,7 +1236,6 @@ module OneSignal
|
|
1235
1236
|
is_wp_wns == o.is_wp_wns &&
|
1236
1237
|
is_adm == o.is_adm &&
|
1237
1238
|
is_chrome == o.is_chrome &&
|
1238
|
-
channel_for_external_user_ids == o.channel_for_external_user_ids &&
|
1239
1239
|
app_id == o.app_id &&
|
1240
1240
|
external_id == o.external_id &&
|
1241
1241
|
idempotency_key == o.idempotency_key &&
|
@@ -1304,6 +1304,8 @@ module OneSignal
|
|
1304
1304
|
thread_id == o.thread_id &&
|
1305
1305
|
summary_arg == o.summary_arg &&
|
1306
1306
|
summary_arg_count == o.summary_arg_count &&
|
1307
|
+
ios_relevance_score == o.ios_relevance_score &&
|
1308
|
+
ios_interruption_level == o.ios_interruption_level &&
|
1307
1309
|
email_subject == o.email_subject &&
|
1308
1310
|
email_body == o.email_body &&
|
1309
1311
|
email_from_name == o.email_from_name &&
|
@@ -1326,7 +1328,7 @@ module OneSignal
|
|
1326
1328
|
# Calculates hash code according to all attributes.
|
1327
1329
|
# @return [Integer] Hash code
|
1328
1330
|
def hash
|
1329
|
-
[included_segments, excluded_segments,
|
1331
|
+
[included_segments, excluded_segments, include_subscription_ids, include_email_tokens, include_phone_numbers, include_ios_tokens, include_wp_wns_uris, include_amazon_reg_ids, include_chrome_reg_ids, include_chrome_web_reg_ids, include_android_reg_ids, include_aliases, target_channel, id, value, name, aggregation, is_ios, is_android, is_huawei, is_any_web, is_chrome_web, is_firefox, is_safari, is_wp_wns, is_adm, is_chrome, app_id, external_id, idempotency_key, contents, headings, subtitle, data, huawei_msg_type, url, web_url, app_url, ios_attachments, template_id, content_available, mutable_content, target_content_identifier, big_picture, huawei_big_picture, adm_big_picture, chrome_big_picture, chrome_web_image, buttons, web_buttons, ios_category, android_channel_id, huawei_channel_id, existing_android_channel_id, huawei_existing_channel_id, android_background_layout, small_icon, huawei_small_icon, large_icon, huawei_large_icon, adm_small_icon, adm_large_icon, chrome_web_icon, chrome_web_badge, firefox_icon, chrome_icon, ios_sound, android_sound, huawei_sound, adm_sound, wp_wns_sound, android_led_color, huawei_led_color, android_accent_color, huawei_accent_color, android_visibility, huawei_visibility, ios_badge_type, ios_badge_count, collapse_id, web_push_topic, apns_alert, delayed_option, delivery_time_of_day, ttl, priority, apns_push_type_override, throttle_rate_per_minute, android_group, android_group_message, adm_group, adm_group_message, thread_id, summary_arg, summary_arg_count, ios_relevance_score, ios_interruption_level, email_subject, email_body, email_from_name, email_from_address, email_preheader, include_unsubscribed, sms_from, sms_media_urls, filters, custom_data, send_after].hash
|
1330
1332
|
end
|
1331
1333
|
|
1332
1334
|
# Builds the object from hash
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.
|
6
|
+
The version of the OpenAPI document: 5.1.0
|
7
7
|
Contact: devrel@onesignal.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.
|
6
|
+
The version of the OpenAPI document: 5.1.0
|
7
7
|
Contact: devrel@onesignal.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.
|
6
|
+
The version of the OpenAPI document: 5.1.0
|
7
7
|
Contact: devrel@onesignal.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 1.
|
6
|
+
The version of the OpenAPI document: 5.1.0
|
7
7
|
Contact: devrel@onesignal.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0-SNAPSHOT
|
@@ -21,11 +21,8 @@ module OneSignal
|
|
21
21
|
# Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [\"Active Users\", \"Inactive Users\"]
|
22
22
|
attr_accessor :excluded_segments
|
23
23
|
|
24
|
-
# Specific
|
25
|
-
attr_accessor :
|
26
|
-
|
27
|
-
# Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [\"custom-id-assigned-by-api\"] 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 channel_for_external_user_ids to indicate you are sending a push or email or sms.
|
28
|
-
attr_accessor :include_external_user_ids
|
24
|
+
# Specific subscription ids to send your notification to. _Does not require API Auth Key._ Not compatible with any other targeting parameters. Example: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call
|
25
|
+
attr_accessor :include_subscription_ids
|
29
26
|
|
30
27
|
# Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: nick@catfac.ts Limit of 2,000 entries per REST API call
|
31
28
|
attr_accessor :include_email_tokens
|
@@ -33,24 +30,25 @@ module OneSignal
|
|
33
30
|
# Recommended for Sending SMS - Target specific phone numbers. The phone number should be in the E.164 format. Phone number should be an existing subscriber on OneSignal. Refer our docs to learn how to add phone numbers to OneSignal. Example phone number: +1999999999 Limit of 2,000 entries per REST API call
|
34
31
|
attr_accessor :include_phone_numbers
|
35
32
|
|
36
|
-
# Not Recommended: Please consider using
|
33
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call
|
37
34
|
attr_accessor :include_ios_tokens
|
38
35
|
|
39
|
-
# Not Recommended: Please consider using
|
36
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call
|
40
37
|
attr_accessor :include_wp_wns_uris
|
41
38
|
|
42
|
-
# Not Recommended: Please consider using
|
39
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call
|
43
40
|
attr_accessor :include_amazon_reg_ids
|
44
41
|
|
45
|
-
# Not Recommended: Please consider using
|
42
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
|
46
43
|
attr_accessor :include_chrome_reg_ids
|
47
44
|
|
48
|
-
# Not Recommended: Please consider using
|
45
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
|
49
46
|
attr_accessor :include_chrome_web_reg_ids
|
50
47
|
|
51
|
-
# Not Recommended: Please consider using
|
48
|
+
# Not Recommended: Please consider using include_subscription_ids or include_aliases instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call
|
52
49
|
attr_accessor :include_android_reg_ids
|
53
50
|
|
51
|
+
# 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.
|
54
52
|
attr_accessor :include_aliases
|
55
53
|
|
56
54
|
attr_accessor :target_channel
|
@@ -82,8 +80,7 @@ module OneSignal
|
|
82
80
|
{
|
83
81
|
:'included_segments' => :'included_segments',
|
84
82
|
:'excluded_segments' => :'excluded_segments',
|
85
|
-
:'
|
86
|
-
:'include_external_user_ids' => :'include_external_user_ids',
|
83
|
+
:'include_subscription_ids' => :'include_subscription_ids',
|
87
84
|
:'include_email_tokens' => :'include_email_tokens',
|
88
85
|
:'include_phone_numbers' => :'include_phone_numbers',
|
89
86
|
:'include_ios_tokens' => :'include_ios_tokens',
|
@@ -107,8 +104,7 @@ module OneSignal
|
|
107
104
|
{
|
108
105
|
:'included_segments' => :'Array<String>',
|
109
106
|
:'excluded_segments' => :'Array<String>',
|
110
|
-
:'
|
111
|
-
:'include_external_user_ids' => :'Array<String>',
|
107
|
+
:'include_subscription_ids' => :'Array<String>',
|
112
108
|
:'include_email_tokens' => :'Array<String>',
|
113
109
|
:'include_phone_numbers' => :'Array<String>',
|
114
110
|
:'include_ios_tokens' => :'Array<String>',
|
@@ -117,7 +113,7 @@ module OneSignal
|
|
117
113
|
:'include_chrome_reg_ids' => :'Array<String>',
|
118
114
|
:'include_chrome_web_reg_ids' => :'Array<String>',
|
119
115
|
:'include_android_reg_ids' => :'Array<String>',
|
120
|
-
:'include_aliases' => :'
|
116
|
+
:'include_aliases' => :'Hash<String, Array<String>>',
|
121
117
|
:'target_channel' => :'String'
|
122
118
|
}
|
123
119
|
end
|
@@ -125,8 +121,7 @@ module OneSignal
|
|
125
121
|
# List of attributes with nullable: true
|
126
122
|
def self.openapi_nullable
|
127
123
|
Set.new([
|
128
|
-
:'
|
129
|
-
:'include_external_user_ids',
|
124
|
+
:'include_subscription_ids',
|
130
125
|
:'include_aliases',
|
131
126
|
])
|
132
127
|
end
|
@@ -134,8 +129,8 @@ module OneSignal
|
|
134
129
|
# List of class defined in anyOf (OpenAPI v3)
|
135
130
|
def self.openapi_any_of
|
136
131
|
[
|
137
|
-
:'
|
138
|
-
:'
|
132
|
+
:'SegmentNotificationTarget',
|
133
|
+
:'SubscriptionNotificationTarget'
|
139
134
|
]
|
140
135
|
end
|
141
136
|
|
@@ -166,15 +161,9 @@ module OneSignal
|
|
166
161
|
end
|
167
162
|
end
|
168
163
|
|
169
|
-
if attributes.key?(:'
|
170
|
-
if (value = attributes[:'
|
171
|
-
self.
|
172
|
-
end
|
173
|
-
end
|
174
|
-
|
175
|
-
if attributes.key?(:'include_external_user_ids')
|
176
|
-
if (value = attributes[:'include_external_user_ids']).is_a?(Array)
|
177
|
-
self.include_external_user_ids = value
|
164
|
+
if attributes.key?(:'include_subscription_ids')
|
165
|
+
if (value = attributes[:'include_subscription_ids']).is_a?(Array)
|
166
|
+
self.include_subscription_ids = value
|
178
167
|
end
|
179
168
|
end
|
180
169
|
|
@@ -227,7 +216,9 @@ module OneSignal
|
|
227
216
|
end
|
228
217
|
|
229
218
|
if attributes.key?(:'include_aliases')
|
230
|
-
|
219
|
+
if (value = attributes[:'include_aliases']).is_a?(Hash)
|
220
|
+
self.include_aliases = value
|
221
|
+
end
|
231
222
|
end
|
232
223
|
|
233
224
|
if attributes.key?(:'target_channel')
|
@@ -279,8 +270,7 @@ module OneSignal
|
|
279
270
|
self.class == o.class &&
|
280
271
|
included_segments == o.included_segments &&
|
281
272
|
excluded_segments == o.excluded_segments &&
|
282
|
-
|
283
|
-
include_external_user_ids == o.include_external_user_ids &&
|
273
|
+
include_subscription_ids == o.include_subscription_ids &&
|
284
274
|
include_email_tokens == o.include_email_tokens &&
|
285
275
|
include_phone_numbers == o.include_phone_numbers &&
|
286
276
|
include_ios_tokens == o.include_ios_tokens &&
|
@@ -302,7 +292,7 @@ module OneSignal
|
|
302
292
|
# Calculates hash code according to all attributes.
|
303
293
|
# @return [Integer] Hash code
|
304
294
|
def hash
|
305
|
-
[included_segments, excluded_segments,
|
295
|
+
[included_segments, excluded_segments, include_subscription_ids, include_email_tokens, include_phone_numbers, include_ios_tokens, include_wp_wns_uris, include_amazon_reg_ids, include_chrome_reg_ids, include_chrome_web_reg_ids, include_android_reg_ids, include_aliases, target_channel].hash
|
306
296
|
end
|
307
297
|
|
308
298
|
# Builds the object from hash
|