onesignal 5.2.1.pre.beta1 → 5.3.0

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.
Files changed (168) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +33 -5
  4. data/docs/ApiKeyToken.md +28 -0
  5. data/docs/ApiKeyTokensListResponse.md +18 -0
  6. data/docs/BasicNotification.md +13 -1
  7. data/docs/BasicNotificationAllOf.md +13 -1
  8. data/docs/CopyTemplateRequest.md +18 -0
  9. data/docs/CreateApiKeyRequest.md +22 -0
  10. data/docs/CreateApiKeyResponse.md +20 -0
  11. data/docs/CreateTemplateRequest.md +32 -0
  12. data/docs/CustomEvent.md +26 -0
  13. data/docs/CustomEventsRequest.md +18 -0
  14. data/docs/DefaultApi.md +1132 -110
  15. data/docs/Notification.md +12 -0
  16. data/docs/NotificationWithMeta.md +12 -0
  17. data/docs/StartLiveActivityRequest.md +48 -0
  18. data/docs/StartLiveActivitySuccessResponse.md +18 -0
  19. data/docs/TemplateResource.md +28 -0
  20. data/docs/TemplatesListResponse.md +18 -0
  21. data/docs/UpdateApiKeyRequest.md +22 -0
  22. data/docs/UpdateTemplateRequest.md +30 -0
  23. data/lib/onesignal/api/default_api.rb +1043 -1
  24. data/lib/onesignal/api_client.rb +2 -2
  25. data/lib/onesignal/api_error.rb +1 -1
  26. data/lib/onesignal/configuration.rb +1 -1
  27. data/lib/onesignal/models/api_key_token.rb +300 -0
  28. data/lib/onesignal/models/api_key_tokens_list_response.rb +221 -0
  29. data/lib/onesignal/models/app.rb +1 -1
  30. data/lib/onesignal/models/basic_notification.rb +84 -6
  31. data/lib/onesignal/models/basic_notification_all_of.rb +84 -6
  32. data/lib/onesignal/models/basic_notification_all_of_android_background_layout.rb +1 -1
  33. data/lib/onesignal/models/button.rb +1 -1
  34. data/lib/onesignal/models/copy_template_request.rb +225 -0
  35. data/lib/onesignal/models/create_api_key_request.rb +273 -0
  36. data/lib/onesignal/models/create_api_key_response.rb +228 -0
  37. data/lib/onesignal/models/create_notification_success_response.rb +1 -1
  38. data/lib/onesignal/models/create_segment_conflict_response.rb +1 -1
  39. data/lib/onesignal/models/create_segment_success_response.rb +1 -1
  40. data/lib/onesignal/models/create_template_request.rb +307 -0
  41. data/lib/onesignal/models/create_user_conflict_response.rb +1 -1
  42. data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +1 -1
  43. data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +1 -1
  44. data/lib/onesignal/models/custom_event.rb +269 -0
  45. data/lib/onesignal/models/custom_events_request.rb +226 -0
  46. data/lib/onesignal/models/delivery_data.rb +1 -1
  47. data/lib/onesignal/models/export_events_success_response.rb +1 -1
  48. data/lib/onesignal/models/export_subscriptions_request_body.rb +1 -1
  49. data/lib/onesignal/models/export_subscriptions_success_response.rb +1 -1
  50. data/lib/onesignal/models/filter.rb +1 -1
  51. data/lib/onesignal/models/filter_expression.rb +1 -1
  52. data/lib/onesignal/models/generic_error.rb +1 -1
  53. data/lib/onesignal/models/generic_success_bool_response.rb +1 -1
  54. data/lib/onesignal/models/get_notification_history_request_body.rb +1 -1
  55. data/lib/onesignal/models/get_segments_success_response.rb +1 -1
  56. data/lib/onesignal/models/language_string_map.rb +1 -1
  57. data/lib/onesignal/models/notification.rb +80 -2
  58. data/lib/onesignal/models/notification_all_of.rb +1 -1
  59. data/lib/onesignal/models/notification_history_success_response.rb +1 -1
  60. data/lib/onesignal/models/notification_slice.rb +1 -1
  61. data/lib/onesignal/models/notification_target.rb +1 -1
  62. data/lib/onesignal/models/notification_with_meta.rb +80 -2
  63. data/lib/onesignal/models/notification_with_meta_all_of.rb +1 -1
  64. data/lib/onesignal/models/operator.rb +1 -1
  65. data/lib/onesignal/models/outcome_data.rb +1 -1
  66. data/lib/onesignal/models/outcomes_data.rb +1 -1
  67. data/lib/onesignal/models/platform_delivery_data.rb +1 -1
  68. data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +1 -1
  69. data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +1 -1
  70. data/lib/onesignal/models/properties_body.rb +1 -1
  71. data/lib/onesignal/models/properties_deltas.rb +1 -1
  72. data/lib/onesignal/models/properties_object.rb +1 -1
  73. data/lib/onesignal/models/purchase.rb +1 -1
  74. data/lib/onesignal/models/rate_limit_error.rb +1 -1
  75. data/lib/onesignal/models/segment.rb +1 -1
  76. data/lib/onesignal/models/segment_data.rb +1 -1
  77. data/lib/onesignal/models/segment_notification_target.rb +1 -1
  78. data/lib/onesignal/models/start_live_activity_request.rb +454 -0
  79. data/lib/onesignal/models/start_live_activity_success_response.rb +219 -0
  80. data/lib/onesignal/models/subscription.rb +1 -1
  81. data/lib/onesignal/models/subscription_body.rb +1 -1
  82. data/lib/onesignal/models/subscription_notification_target.rb +1 -1
  83. data/lib/onesignal/models/template_resource.rb +302 -0
  84. data/lib/onesignal/models/templates_list_response.rb +221 -0
  85. data/lib/onesignal/models/transfer_subscription_request_body.rb +1 -1
  86. data/lib/onesignal/models/update_api_key_request.rb +273 -0
  87. data/lib/onesignal/models/update_live_activity_request.rb +1 -1
  88. data/lib/onesignal/models/update_live_activity_success_response.rb +1 -1
  89. data/lib/onesignal/models/update_template_request.rb +282 -0
  90. data/lib/onesignal/models/update_user_request.rb +1 -1
  91. data/lib/onesignal/models/user.rb +1 -1
  92. data/lib/onesignal/models/user_identity_body.rb +1 -1
  93. data/lib/onesignal/models/web_button.rb +1 -1
  94. data/lib/onesignal/version.rb +2 -2
  95. data/lib/onesignal.rb +15 -1
  96. data/onesignal.gemspec +1 -1
  97. data/spec/api/default_api_spec.rb +189 -1
  98. data/spec/api_client_spec.rb +1 -1
  99. data/spec/configuration_spec.rb +1 -1
  100. data/spec/models/api_key_token_spec.rb +68 -0
  101. data/spec/models/api_key_tokens_list_response_spec.rb +34 -0
  102. data/spec/models/app_spec.rb +1 -1
  103. data/spec/models/basic_notification_all_of_android_background_layout_spec.rb +1 -1
  104. data/spec/models/basic_notification_all_of_spec.rb +41 -1
  105. data/spec/models/basic_notification_spec.rb +41 -1
  106. data/spec/models/button_spec.rb +1 -1
  107. data/spec/models/copy_template_request_spec.rb +34 -0
  108. data/spec/models/create_api_key_request_spec.rb +50 -0
  109. data/spec/models/create_api_key_response_spec.rb +40 -0
  110. data/spec/models/create_notification_success_response_spec.rb +1 -1
  111. data/spec/models/create_segment_conflict_response_spec.rb +1 -1
  112. data/spec/models/create_segment_success_response_spec.rb +1 -1
  113. data/spec/models/create_template_request_spec.rb +76 -0
  114. data/spec/models/create_user_conflict_response_errors_inner_spec.rb +1 -1
  115. data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +1 -1
  116. data/spec/models/create_user_conflict_response_spec.rb +1 -1
  117. data/spec/models/custom_event_spec.rb +58 -0
  118. data/spec/models/custom_events_request_spec.rb +34 -0
  119. data/spec/models/delivery_data_spec.rb +1 -1
  120. data/spec/models/export_events_success_response_spec.rb +1 -1
  121. data/spec/models/export_subscriptions_request_body_spec.rb +1 -1
  122. data/spec/models/export_subscriptions_success_response_spec.rb +1 -1
  123. data/spec/models/filter_expression_spec.rb +1 -1
  124. data/spec/models/filter_spec.rb +1 -1
  125. data/spec/models/generic_error_spec.rb +1 -1
  126. data/spec/models/generic_success_bool_response_spec.rb +1 -1
  127. data/spec/models/get_notification_history_request_body_spec.rb +1 -1
  128. data/spec/models/get_segments_success_response_spec.rb +1 -1
  129. data/spec/models/language_string_map_spec.rb +1 -1
  130. data/spec/models/notification_all_of_spec.rb +1 -1
  131. data/spec/models/notification_history_success_response_spec.rb +1 -1
  132. data/spec/models/notification_slice_spec.rb +1 -1
  133. data/spec/models/notification_spec.rb +41 -1
  134. data/spec/models/notification_target_spec.rb +1 -1
  135. data/spec/models/notification_with_meta_all_of_spec.rb +1 -1
  136. data/spec/models/notification_with_meta_spec.rb +41 -1
  137. data/spec/models/operator_spec.rb +1 -1
  138. data/spec/models/outcome_data_spec.rb +1 -1
  139. data/spec/models/outcomes_data_spec.rb +1 -1
  140. data/spec/models/platform_delivery_data_email_all_of_spec.rb +1 -1
  141. data/spec/models/platform_delivery_data_sms_all_of_spec.rb +1 -1
  142. data/spec/models/platform_delivery_data_spec.rb +1 -1
  143. data/spec/models/properties_body_spec.rb +1 -1
  144. data/spec/models/properties_deltas_spec.rb +1 -1
  145. data/spec/models/properties_object_spec.rb +1 -1
  146. data/spec/models/purchase_spec.rb +1 -1
  147. data/spec/models/rate_limit_error_spec.rb +1 -1
  148. data/spec/models/segment_data_spec.rb +1 -1
  149. data/spec/models/segment_notification_target_spec.rb +1 -1
  150. data/spec/models/segment_spec.rb +1 -1
  151. data/spec/models/start_live_activity_request_spec.rb +128 -0
  152. data/spec/models/start_live_activity_success_response_spec.rb +34 -0
  153. data/spec/models/subscription_body_spec.rb +1 -1
  154. data/spec/models/subscription_notification_target_spec.rb +1 -1
  155. data/spec/models/subscription_spec.rb +1 -1
  156. data/spec/models/template_resource_spec.rb +68 -0
  157. data/spec/models/templates_list_response_spec.rb +34 -0
  158. data/spec/models/transfer_subscription_request_body_spec.rb +1 -1
  159. data/spec/models/update_api_key_request_spec.rb +50 -0
  160. data/spec/models/update_live_activity_request_spec.rb +1 -1
  161. data/spec/models/update_live_activity_success_response_spec.rb +1 -1
  162. data/spec/models/update_template_request_spec.rb +70 -0
  163. data/spec/models/update_user_request_spec.rb +1 -1
  164. data/spec/models/user_identity_body_spec.rb +1 -1
  165. data/spec/models/user_spec.rb +1 -1
  166. data/spec/models/web_button_spec.rb +1 -1
  167. data/spec/spec_helper.rb +1 -1
  168. metadata +58 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5978461cc410788844129221a7e5ee1585e8700154876bbf876a1d4dbbb5fdf3
4
- data.tar.gz: 9753ab014038ef8ed32e701bbc0292d643aadb5827acb4fbb89f8e9bc381cf46
3
+ metadata.gz: e1ba8557c331dcf807a3dc7881bb816466841a3738c4f7dcb1c72aa011d34113
4
+ data.tar.gz: 6cc988483ff1bcfe9865f5fae79a50991a122fb6bc275b5b9b9b54351a5bcb7d
5
5
  SHA512:
6
- metadata.gz: f9f65c675c6c31e9cec3e4934289b76cec39b5a78ba6b7a3e40b3402fd51dca4528be214ece4ef600ce6c75361a302b1fe8ed8fc36141ad77c99b650adeed034
7
- data.tar.gz: 85989b8ab54d3f5d3184603964c601e9fe6e6cb6b9de924880682d980dababe148100fb7b2df652a282eb6c3351dd491450e6de0a607cac24c750e0424672349
6
+ metadata.gz: 0c11585a2eab09c69d5e0aac35770df4b4418dd8d3f76867ea446f29f55906508c10c1184f77e2cf22c8525ba87fbc8bdb447d4a5dee937627df829d86b1ec08
7
+ data.tar.gz: b4833c4f5b1ad25fb4d6e23ac6711bf1febb4bd19aa5c7aada1f6db64651407cfd2d37e27d37a693c0a0980910bde8e022d9933de9010c20750669ed157c4fe2
data/CHANGELOG.md CHANGED
@@ -1,3 +1,11 @@
1
+ # Changelog
2
+
3
+ ## [5.3.0](https://github.com/OneSignal/onesignal-ruby-api/compare/v5.2.0...v5.3.0) (2026-03-24)
4
+
5
+ ### Features
6
+
7
+ * add Huawei and email_reply_to_address parameters to Notification ([#61](https://github.com/OneSignal/onesignal-ruby-api/issues/61)) ([9777640](https://github.com/OneSignal/onesignal-ruby-api/commit/97776405f6125f480f1ff7db04f8e497fae8c4ad))
8
+
1
9
  # Change Log
2
10
  All notable changes to this project will be documented in this file.
3
11
  This project adheres to [Semantic Versioning](http://semver.org/).
data/README.md CHANGED
@@ -6,8 +6,8 @@ A powerful way to send personalized messages at scale and build effective custom
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: 5.2.1
10
- - Package version: 5.2.1-beta1
9
+ - API version: 5.3.0
10
+ - Package version: 5.3.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://onesignal.com](https://onesignal.com)
13
13
 
@@ -24,16 +24,16 @@ gem build onesignal.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./onesignal-5.2.1-beta1.gem
27
+ gem install ./onesignal-5.3.0.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./onesignal-5.2.1-beta1.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./onesignal-5.3.0.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'onesignal', '~> 5.2.1-beta1'
36
+ gem 'onesignal', '~> 5.3.0'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -86,16 +86,22 @@ All URIs are relative to *https://api.onesignal.com*
86
86
  Class | Method | HTTP request | Description
87
87
  ------------ | ------------- | ------------- | -------------
88
88
  *OneSignal::DefaultApi* | [**cancel_notification**](docs/DefaultApi.md#cancel_notification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification
89
+ *OneSignal::DefaultApi* | [**copy_template_to_app**](docs/DefaultApi.md#copy_template_to_app) | **POST** /templates/{template_id}/copy_to_app | Copy template to another app
89
90
  *OneSignal::DefaultApi* | [**create_alias**](docs/DefaultApi.md#create_alias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
90
91
  *OneSignal::DefaultApi* | [**create_alias_by_subscription**](docs/DefaultApi.md#create_alias_by_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
92
+ *OneSignal::DefaultApi* | [**create_api_key**](docs/DefaultApi.md#create_api_key) | **POST** /apps/{app_id}/auth/tokens | Create API key
91
93
  *OneSignal::DefaultApi* | [**create_app**](docs/DefaultApi.md#create_app) | **POST** /apps | Create an app
94
+ *OneSignal::DefaultApi* | [**create_custom_events**](docs/DefaultApi.md#create_custom_events) | **POST** /apps/{app_id}/integrations/custom_events | Create custom events
92
95
  *OneSignal::DefaultApi* | [**create_notification**](docs/DefaultApi.md#create_notification) | **POST** /notifications | Create notification
93
96
  *OneSignal::DefaultApi* | [**create_segment**](docs/DefaultApi.md#create_segment) | **POST** /apps/{app_id}/segments | Create Segment
94
97
  *OneSignal::DefaultApi* | [**create_subscription**](docs/DefaultApi.md#create_subscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
98
+ *OneSignal::DefaultApi* | [**create_template**](docs/DefaultApi.md#create_template) | **POST** /templates | Create template
95
99
  *OneSignal::DefaultApi* | [**create_user**](docs/DefaultApi.md#create_user) | **POST** /apps/{app_id}/users |
96
100
  *OneSignal::DefaultApi* | [**delete_alias**](docs/DefaultApi.md#delete_alias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} |
101
+ *OneSignal::DefaultApi* | [**delete_api_key**](docs/DefaultApi.md#delete_api_key) | **DELETE** /apps/{app_id}/auth/tokens/{token_id} | Delete API key
97
102
  *OneSignal::DefaultApi* | [**delete_segment**](docs/DefaultApi.md#delete_segment) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment
98
103
  *OneSignal::DefaultApi* | [**delete_subscription**](docs/DefaultApi.md#delete_subscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} |
104
+ *OneSignal::DefaultApi* | [**delete_template**](docs/DefaultApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete template
99
105
  *OneSignal::DefaultApi* | [**delete_user**](docs/DefaultApi.md#delete_user) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
100
106
  *OneSignal::DefaultApi* | [**export_events**](docs/DefaultApi.md#export_events) | **POST** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events
101
107
  *OneSignal::DefaultApi* | [**export_subscriptions**](docs/DefaultApi.md#export_subscriptions) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions
@@ -109,27 +115,43 @@ Class | Method | HTTP request | Description
109
115
  *OneSignal::DefaultApi* | [**get_outcomes**](docs/DefaultApi.md#get_outcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes
110
116
  *OneSignal::DefaultApi* | [**get_segments**](docs/DefaultApi.md#get_segments) | **GET** /apps/{app_id}/segments | Get Segments
111
117
  *OneSignal::DefaultApi* | [**get_user**](docs/DefaultApi.md#get_user) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
118
+ *OneSignal::DefaultApi* | [**rotate_api_key**](docs/DefaultApi.md#rotate_api_key) | **POST** /apps/{app_id}/auth/tokens/{token_id}/rotate | Rotate API key
119
+ *OneSignal::DefaultApi* | [**start_live_activity**](docs/DefaultApi.md#start_live_activity) | **POST** /apps/{app_id}/activities/activity/{activity_type} | Start Live Activity
112
120
  *OneSignal::DefaultApi* | [**transfer_subscription**](docs/DefaultApi.md#transfer_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner |
113
121
  *OneSignal::DefaultApi* | [**unsubscribe_email_with_token**](docs/DefaultApi.md#unsubscribe_email_with_token) | **POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token
122
+ *OneSignal::DefaultApi* | [**update_api_key**](docs/DefaultApi.md#update_api_key) | **PATCH** /apps/{app_id}/auth/tokens/{token_id} | Update API key
114
123
  *OneSignal::DefaultApi* | [**update_app**](docs/DefaultApi.md#update_app) | **PUT** /apps/{app_id} | Update an app
115
124
  *OneSignal::DefaultApi* | [**update_live_activity**](docs/DefaultApi.md#update_live_activity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push
116
125
  *OneSignal::DefaultApi* | [**update_subscription**](docs/DefaultApi.md#update_subscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} |
126
+ *OneSignal::DefaultApi* | [**update_subscription_by_token**](docs/DefaultApi.md#update_subscription_by_token) | **PATCH** /apps/{app_id}/subscriptions_by_token/{token_type}/{token} | Update subscription by token
127
+ *OneSignal::DefaultApi* | [**update_template**](docs/DefaultApi.md#update_template) | **PATCH** /templates/{template_id} | Update template
117
128
  *OneSignal::DefaultApi* | [**update_user**](docs/DefaultApi.md#update_user) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
129
+ *OneSignal::DefaultApi* | [**view_api_keys**](docs/DefaultApi.md#view_api_keys) | **GET** /apps/{app_id}/auth/tokens | View API keys
130
+ *OneSignal::DefaultApi* | [**view_template**](docs/DefaultApi.md#view_template) | **GET** /templates/{template_id} | View template
131
+ *OneSignal::DefaultApi* | [**view_templates**](docs/DefaultApi.md#view_templates) | **GET** /templates | View templates
118
132
 
119
133
 
120
134
  ## Documentation for Models
121
135
 
136
+ - [OneSignal::ApiKeyToken](docs/ApiKeyToken.md)
137
+ - [OneSignal::ApiKeyTokensListResponse](docs/ApiKeyTokensListResponse.md)
122
138
  - [OneSignal::App](docs/App.md)
123
139
  - [OneSignal::BasicNotification](docs/BasicNotification.md)
124
140
  - [OneSignal::BasicNotificationAllOf](docs/BasicNotificationAllOf.md)
125
141
  - [OneSignal::BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md)
126
142
  - [OneSignal::Button](docs/Button.md)
143
+ - [OneSignal::CopyTemplateRequest](docs/CopyTemplateRequest.md)
144
+ - [OneSignal::CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
145
+ - [OneSignal::CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
127
146
  - [OneSignal::CreateNotificationSuccessResponse](docs/CreateNotificationSuccessResponse.md)
128
147
  - [OneSignal::CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md)
129
148
  - [OneSignal::CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md)
149
+ - [OneSignal::CreateTemplateRequest](docs/CreateTemplateRequest.md)
130
150
  - [OneSignal::CreateUserConflictResponse](docs/CreateUserConflictResponse.md)
131
151
  - [OneSignal::CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md)
132
152
  - [OneSignal::CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.md)
153
+ - [OneSignal::CustomEvent](docs/CustomEvent.md)
154
+ - [OneSignal::CustomEventsRequest](docs/CustomEventsRequest.md)
133
155
  - [OneSignal::DeliveryData](docs/DeliveryData.md)
134
156
  - [OneSignal::ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md)
135
157
  - [OneSignal::ExportSubscriptionsRequestBody](docs/ExportSubscriptionsRequestBody.md)
@@ -162,12 +184,18 @@ Class | Method | HTTP request | Description
162
184
  - [OneSignal::Segment](docs/Segment.md)
163
185
  - [OneSignal::SegmentData](docs/SegmentData.md)
164
186
  - [OneSignal::SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
187
+ - [OneSignal::StartLiveActivityRequest](docs/StartLiveActivityRequest.md)
188
+ - [OneSignal::StartLiveActivitySuccessResponse](docs/StartLiveActivitySuccessResponse.md)
165
189
  - [OneSignal::Subscription](docs/Subscription.md)
166
190
  - [OneSignal::SubscriptionBody](docs/SubscriptionBody.md)
167
191
  - [OneSignal::SubscriptionNotificationTarget](docs/SubscriptionNotificationTarget.md)
192
+ - [OneSignal::TemplateResource](docs/TemplateResource.md)
193
+ - [OneSignal::TemplatesListResponse](docs/TemplatesListResponse.md)
168
194
  - [OneSignal::TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.md)
195
+ - [OneSignal::UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
169
196
  - [OneSignal::UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md)
170
197
  - [OneSignal::UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md)
198
+ - [OneSignal::UpdateTemplateRequest](docs/UpdateTemplateRequest.md)
171
199
  - [OneSignal::UpdateUserRequest](docs/UpdateUserRequest.md)
172
200
  - [OneSignal::User](docs/User.md)
173
201
  - [OneSignal::UserIdentityBody](docs/UserIdentityBody.md)
@@ -0,0 +1,28 @@
1
+ # OneSignal::ApiKeyToken
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **token_id** | **String** | | [optional] |
8
+ | **updated_at** | **String** | | [optional] |
9
+ | **created_at** | **String** | | [optional] |
10
+ | **name** | **String** | | [optional] |
11
+ | **ip_allowlist_mode** | **String** | | [optional] |
12
+ | **ip_allowlist** | **Array<String>** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'onesignal'
18
+
19
+ instance = OneSignal::ApiKeyToken.new(
20
+ token_id: null,
21
+ updated_at: null,
22
+ created_at: null,
23
+ name: null,
24
+ ip_allowlist_mode: null,
25
+ ip_allowlist: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,18 @@
1
+ # OneSignal::ApiKeyTokensListResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **tokens** | [**Array<ApiKeyToken>**](ApiKeyToken.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'onesignal'
13
+
14
+ instance = OneSignal::ApiKeyTokensListResponse.new(
15
+ tokens: null
16
+ )
17
+ ```
18
+
@@ -105,6 +105,7 @@
105
105
  | **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] |
106
106
  | **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] |
107
107
  | **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] |
108
+ | **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] |
108
109
  | **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] |
109
110
  | **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] |
110
111
  | **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 @@
112
113
  | **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] |
113
114
  | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
114
115
  | **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] |
116
+ | **huawei_badge_class** | **String** | Channel: Push Notifications Platform: Huawei Full path of the app entry activity class | [optional] |
117
+ | **huawei_badge_add_num** | **Integer** | Channel: Push Notifications Platform: Huawei Accumulative badge number, which is an integer ranging from 1 to 99 | [optional] |
118
+ | **huawei_badge_set_num** | **Integer** | Channel: Push Notifications Platform: Huawei Badge number, which is an integer ranging from 0 to 99 | [optional] |
119
+ | **huawei_category** | **String** | Channel: Push Notifications Platform: Huawei Category of the push notification for HMS classification. | [optional] |
120
+ | **huawei_bi_tag** | **String** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] |
115
121
 
116
122
  ## Example
117
123
 
@@ -220,13 +226,19 @@ instance = OneSignal::BasicNotification.new(
220
226
  email_body: null,
221
227
  email_from_name: null,
222
228
  email_from_address: null,
229
+ email_reply_to_address: null,
223
230
  email_preheader: null,
224
231
  disable_email_click_tracking: null,
225
232
  include_unsubscribed: null,
226
233
  sms_from: null,
227
234
  sms_media_urls: null,
228
235
  filters: null,
229
- custom_data: null
236
+ custom_data: null,
237
+ huawei_badge_class: null,
238
+ huawei_badge_add_num: null,
239
+ huawei_badge_set_num: null,
240
+ huawei_category: null,
241
+ huawei_bi_tag: null
230
242
  )
231
243
  ```
232
244
 
@@ -92,6 +92,7 @@
92
92
  | **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] |
93
93
  | **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] |
94
94
  | **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] |
95
+ | **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] |
95
96
  | **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] |
96
97
  | **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] |
97
98
  | **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] |
@@ -99,6 +100,11 @@
99
100
  | **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] |
100
101
  | **filters** | [**Array<FilterExpression>**](FilterExpression.md) | | [optional] |
101
102
  | **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] |
103
+ | **huawei_badge_class** | **String** | Channel: Push Notifications Platform: Huawei Full path of the app entry activity class | [optional] |
104
+ | **huawei_badge_add_num** | **Integer** | Channel: Push Notifications Platform: Huawei Accumulative badge number, which is an integer ranging from 1 to 99 | [optional] |
105
+ | **huawei_badge_set_num** | **Integer** | Channel: Push Notifications Platform: Huawei Badge number, which is an integer ranging from 0 to 99 | [optional] |
106
+ | **huawei_category** | **String** | Channel: Push Notifications Platform: Huawei Category of the push notification for HMS classification. | [optional] |
107
+ | **huawei_bi_tag** | **String** | Channel: Push Notifications Platform: Huawei A tag used for Huawei business intelligence and analytics. | [optional] |
102
108
 
103
109
  ## Example
104
110
 
@@ -194,13 +200,19 @@ instance = OneSignal::BasicNotificationAllOf.new(
194
200
  email_body: null,
195
201
  email_from_name: null,
196
202
  email_from_address: null,
203
+ email_reply_to_address: null,
197
204
  email_preheader: null,
198
205
  disable_email_click_tracking: null,
199
206
  include_unsubscribed: null,
200
207
  sms_from: null,
201
208
  sms_media_urls: null,
202
209
  filters: null,
203
- custom_data: null
210
+ custom_data: null,
211
+ huawei_badge_class: null,
212
+ huawei_badge_add_num: null,
213
+ huawei_badge_set_num: null,
214
+ huawei_category: null,
215
+ huawei_bi_tag: null
204
216
  )
205
217
  ```
206
218
 
@@ -0,0 +1,18 @@
1
+ # OneSignal::CopyTemplateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **target_app_id** | **String** | Destination OneSignal App ID in UUID v4 format. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'onesignal'
13
+
14
+ instance = OneSignal::CopyTemplateRequest.new(
15
+ target_app_id: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # OneSignal::CreateApiKeyRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | [optional] |
8
+ | **ip_allowlist_mode** | **String** | | [optional] |
9
+ | **ip_allowlist** | **Array<String>** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'onesignal'
15
+
16
+ instance = OneSignal::CreateApiKeyRequest.new(
17
+ name: null,
18
+ ip_allowlist_mode: null,
19
+ ip_allowlist: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # OneSignal::CreateApiKeyResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **token_id** | **String** | | [optional] |
8
+ | **formatted_token** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'onesignal'
14
+
15
+ instance = OneSignal::CreateApiKeyResponse.new(
16
+ token_id: null,
17
+ formatted_token: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,32 @@
1
+ # OneSignal::CreateTemplateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **app_id** | **String** | Your OneSignal App ID in UUID v4 format. | |
8
+ | **name** | **String** | Name of the template. | |
9
+ | **contents** | [**LanguageStringMap**](LanguageStringMap.md) | | |
10
+ | **is_email** | **Boolean** | Set true for an Email template. | [optional] |
11
+ | **email_subject** | **String** | Subject of the email. | [optional] |
12
+ | **email_body** | **String** | Body of the email (HTML supported). | [optional] |
13
+ | **is_sms** | **Boolean** | Set true for an SMS template. | [optional] |
14
+ | **dynamic_content** | **String** | JSON string for dynamic content personalization. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'onesignal'
20
+
21
+ instance = OneSignal::CreateTemplateRequest.new(
22
+ app_id: null,
23
+ name: null,
24
+ contents: null,
25
+ is_email: null,
26
+ email_subject: null,
27
+ email_body: null,
28
+ is_sms: null,
29
+ dynamic_content: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,26 @@
1
+ # OneSignal::CustomEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The identifier or name of the event. Maximum 128 characters. | |
8
+ | **external_id** | **String** | The external ID of the user targeted for the event. Either the user's External ID or OneSignal ID is required. | [optional] |
9
+ | **onesignal_id** | **String** | The OneSignal ID of the user targeted for the event. Either the user's External ID or OneSignal ID is required. | [optional] |
10
+ | **timestamp** | **Time** | Time the event occurred as an ISO8601 formatted string. Defaults to now if not included or past date provided. | [optional] |
11
+ | **payload** | **Hash<String, Object>** | Properties or data related to the event, like {\"geography\": \"USA\"} | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'onesignal'
17
+
18
+ instance = OneSignal::CustomEvent.new(
19
+ name: null,
20
+ external_id: null,
21
+ onesignal_id: null,
22
+ timestamp: null,
23
+ payload: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,18 @@
1
+ # OneSignal::CustomEventsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **events** | [**Array<CustomEvent>**](CustomEvent.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'onesignal'
13
+
14
+ instance = OneSignal::CustomEventsRequest.new(
15
+ events: null
16
+ )
17
+ ```
18
+