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.
Files changed (210) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +42 -67
  3. data/docs/BasicNotification.md +18 -18
  4. data/docs/BasicNotificationAllOf.md +9 -7
  5. data/docs/CreateNotificationSuccessResponse.md +1 -3
  6. data/docs/DefaultApi.md +364 -948
  7. data/docs/{ExportPlayersRequestBody.md → ExportSubscriptionsRequestBody.md} +2 -2
  8. data/docs/{ExportPlayersSuccessResponse.md → ExportSubscriptionsSuccessResponse.md} +2 -2
  9. data/docs/Filter.md +10 -2
  10. data/docs/{Notification200Errors.md → FilterExpression.md} +9 -9
  11. data/docs/GenericError.md +6 -2
  12. data/docs/{DeletePlayerSuccessResponse.md → GenericSuccessBoolResponse.md} +2 -2
  13. data/docs/{GetNotificationRequestBody.md → GetNotificationHistoryRequestBody.md} +2 -2
  14. data/docs/GetSegmentsSuccessResponse.md +24 -0
  15. data/docs/{StringMap.md → LanguageStringMap.md} +2 -2
  16. data/docs/Notification.md +18 -18
  17. data/docs/NotificationTarget.md +9 -11
  18. data/docs/NotificationWithMeta.md +18 -18
  19. data/docs/{InlineResponse202.md → PropertiesBody.md} +2 -2
  20. data/docs/PropertiesDeltas.md +2 -2
  21. data/docs/PropertiesObject.md +2 -2
  22. data/docs/Purchase.md +1 -1
  23. data/docs/RateLimitError.md +20 -0
  24. data/docs/Segment.md +1 -1
  25. data/docs/SegmentData.md +30 -0
  26. data/docs/{SubscriptionObject.md → Subscription.md} +6 -6
  27. data/docs/SubscriptionBody.md +18 -0
  28. data/docs/SubscriptionNotificationTarget.md +38 -0
  29. data/docs/TransferSubscriptionRequestBody.md +1 -1
  30. data/docs/UpdateLiveActivityRequest.md +14 -4
  31. data/docs/UpdateLiveActivitySuccessResponse.md +2 -4
  32. data/docs/User.md +3 -5
  33. data/docs/{InlineResponse200.md → UserIdentityBody.md} +3 -3
  34. data/docs/WebButton.md +24 -0
  35. data/lib/onesignal/api/default_api.rb +382 -890
  36. data/lib/onesignal/api_client.rb +2 -2
  37. data/lib/onesignal/api_error.rb +1 -1
  38. data/lib/onesignal/configuration.rb +5 -5
  39. data/lib/onesignal/models/app.rb +1 -1
  40. data/lib/onesignal/models/basic_notification.rb +49 -47
  41. data/lib/onesignal/models/basic_notification_all_of.rb +29 -17
  42. data/lib/onesignal/models/basic_notification_all_of_android_background_layout.rb +1 -1
  43. data/lib/onesignal/models/button.rb +1 -1
  44. data/lib/onesignal/models/create_notification_success_response.rb +5 -13
  45. data/lib/onesignal/models/create_segment_conflict_response.rb +1 -1
  46. data/lib/onesignal/models/create_segment_success_response.rb +1 -1
  47. data/lib/onesignal/models/create_user_conflict_response.rb +1 -1
  48. data/lib/onesignal/models/create_user_conflict_response_errors_inner.rb +1 -1
  49. data/lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb +1 -1
  50. data/lib/onesignal/models/delivery_data.rb +1 -1
  51. data/lib/onesignal/models/export_events_success_response.rb +1 -1
  52. data/lib/onesignal/models/{export_players_request_body.rb → export_subscriptions_request_body.rb} +4 -4
  53. data/lib/onesignal/models/{export_players_success_response.rb → export_subscriptions_success_response.rb} +4 -4
  54. data/lib/onesignal/models/filter.rb +44 -14
  55. data/lib/onesignal/models/{notification200_errors.rb → filter_expression.rb} +4 -4
  56. data/lib/onesignal/models/generic_error.rb +26 -8
  57. data/lib/onesignal/models/{update_player_success_response.rb → generic_success_bool_response.rb} +4 -4
  58. data/lib/onesignal/models/{get_notification_request_body.rb → get_notification_history_request_body.rb} +4 -4
  59. data/lib/onesignal/models/{player_slice.rb → get_segments_success_response.rb} +16 -12
  60. data/lib/onesignal/models/{string_map.rb → language_string_map.rb} +4 -4
  61. data/lib/onesignal/models/notification.rb +49 -47
  62. data/lib/onesignal/models/notification_all_of.rb +1 -1
  63. data/lib/onesignal/models/notification_history_success_response.rb +1 -1
  64. data/lib/onesignal/models/notification_slice.rb +1 -1
  65. data/lib/onesignal/models/notification_target.rb +24 -34
  66. data/lib/onesignal/models/notification_with_meta.rb +49 -47
  67. data/lib/onesignal/models/notification_with_meta_all_of.rb +1 -1
  68. data/lib/onesignal/models/operator.rb +1 -1
  69. data/lib/onesignal/models/outcome_data.rb +1 -1
  70. data/lib/onesignal/models/outcomes_data.rb +1 -1
  71. data/lib/onesignal/models/platform_delivery_data.rb +1 -1
  72. data/lib/onesignal/models/platform_delivery_data_email_all_of.rb +1 -1
  73. data/lib/onesignal/models/platform_delivery_data_sms_all_of.rb +1 -1
  74. data/lib/onesignal/models/{inline_response202.rb → properties_body.rb} +4 -4
  75. data/lib/onesignal/models/properties_deltas.rb +3 -3
  76. data/lib/onesignal/models/properties_object.rb +3 -3
  77. data/lib/onesignal/models/purchase.rb +2 -2
  78. data/lib/onesignal/models/{rate_limiter_error.rb → rate_limit_error.rb} +17 -8
  79. data/lib/onesignal/models/segment.rb +2 -2
  80. data/lib/onesignal/models/{begin_live_activity_request.rb → segment_data.rb} +69 -27
  81. data/lib/onesignal/models/segment_notification_target.rb +1 -1
  82. data/lib/onesignal/models/{subscription_object.rb → subscription.rb} +8 -8
  83. data/lib/onesignal/models/{inline_response201.rb → subscription_body.rb} +5 -5
  84. data/lib/onesignal/models/{player_notification_target.rb → subscription_notification_target.rb} +25 -35
  85. data/lib/onesignal/models/transfer_subscription_request_body.rb +26 -2
  86. data/lib/onesignal/models/update_live_activity_request.rb +59 -22
  87. data/lib/onesignal/models/update_live_activity_success_response.rb +8 -17
  88. data/lib/onesignal/models/update_user_request.rb +1 -1
  89. data/lib/onesignal/models/user.rb +6 -15
  90. data/lib/onesignal/models/{inline_response200.rb → user_identity_body.rb} +5 -5
  91. data/lib/onesignal/models/{create_player_success_response.rb → web_button.rb} +40 -17
  92. data/lib/onesignal/version.rb +2 -2
  93. data/lib/onesignal.rb +16 -34
  94. data/onesignal.gemspec +1 -1
  95. data/spec/api/default_api_spec.rb +82 -174
  96. data/spec/api_client_spec.rb +1 -1
  97. data/spec/configuration_spec.rb +1 -1
  98. data/spec/models/app_spec.rb +1 -1
  99. data/spec/models/basic_notification_all_of_android_background_layout_spec.rb +1 -1
  100. data/spec/models/basic_notification_all_of_spec.rb +13 -7
  101. data/spec/models/basic_notification_spec.rb +14 -14
  102. data/spec/models/button_spec.rb +1 -1
  103. data/spec/models/create_notification_success_response_spec.rb +1 -7
  104. data/spec/models/create_segment_conflict_response_spec.rb +1 -1
  105. data/spec/models/create_segment_success_response_spec.rb +1 -1
  106. data/spec/models/create_user_conflict_response_errors_inner_spec.rb +1 -1
  107. data/spec/models/create_user_conflict_response_errors_items_meta_spec.rb +1 -1
  108. data/spec/models/create_user_conflict_response_spec.rb +1 -1
  109. data/spec/models/delivery_data_spec.rb +1 -1
  110. data/spec/models/export_events_success_response_spec.rb +1 -1
  111. data/spec/models/{export_players_request_body_spec.rb → export_subscriptions_request_body_spec.rb} +7 -7
  112. data/spec/models/{export_players_success_response_spec.rb → export_subscriptions_success_response_spec.rb} +7 -7
  113. data/spec/models/{notification200_errors_spec.rb → filter_expression_spec.rb} +3 -3
  114. data/spec/models/filter_spec.rb +25 -1
  115. data/spec/models/generic_error_spec.rb +13 -1
  116. data/spec/models/{delete_player_success_response_spec.rb → generic_success_bool_response_spec.rb} +7 -7
  117. data/spec/models/{get_notification_request_body_spec.rb → get_notification_history_request_body_spec.rb} +7 -7
  118. data/spec/models/{player_slice_spec.rb → get_segments_success_response_spec.rb} +8 -8
  119. data/spec/models/{string_map_spec.rb → language_string_map_spec.rb} +7 -7
  120. data/spec/models/notification_all_of_spec.rb +1 -1
  121. data/spec/models/notification_history_success_response_spec.rb +1 -1
  122. data/spec/models/notification_slice_spec.rb +1 -1
  123. data/spec/models/notification_spec.rb +14 -14
  124. data/spec/models/notification_target_spec.rb +2 -8
  125. data/spec/models/notification_with_meta_all_of_spec.rb +1 -1
  126. data/spec/models/notification_with_meta_spec.rb +14 -14
  127. data/spec/models/operator_spec.rb +1 -1
  128. data/spec/models/outcome_data_spec.rb +1 -1
  129. data/spec/models/outcomes_data_spec.rb +1 -1
  130. data/spec/models/platform_delivery_data_email_all_of_spec.rb +1 -1
  131. data/spec/models/platform_delivery_data_sms_all_of_spec.rb +1 -1
  132. data/spec/models/platform_delivery_data_spec.rb +1 -1
  133. data/spec/models/{inline_response202_spec.rb → properties_body_spec.rb} +7 -7
  134. data/spec/models/properties_deltas_spec.rb +1 -1
  135. data/spec/models/properties_object_spec.rb +1 -1
  136. data/spec/models/purchase_spec.rb +1 -1
  137. data/spec/models/{generic_error_errors_inner_spec.rb → rate_limit_error_spec.rb} +9 -9
  138. data/spec/models/{filter_expressions_spec.rb → segment_data_spec.rb} +24 -20
  139. data/spec/models/segment_notification_target_spec.rb +1 -1
  140. data/spec/models/segment_spec.rb +1 -1
  141. data/spec/models/{inline_response201_spec.rb → subscription_body_spec.rb} +7 -7
  142. data/spec/models/{player_notification_target_spec.rb → subscription_notification_target_spec.rb} +8 -14
  143. data/spec/models/{subscription_object_spec.rb → subscription_spec.rb} +7 -7
  144. data/spec/models/transfer_subscription_request_body_spec.rb +1 -1
  145. data/spec/models/update_live_activity_request_spec.rb +32 -6
  146. data/spec/models/update_live_activity_success_response_spec.rb +2 -8
  147. data/spec/models/update_user_request_spec.rb +1 -1
  148. data/spec/models/{user_identity_response_spec.rb → user_identity_body_spec.rb} +7 -7
  149. data/spec/models/user_spec.rb +1 -7
  150. data/spec/models/{create_player_success_response_spec.rb → web_button_spec.rb} +21 -9
  151. data/spec/spec_helper.rb +1 -1
  152. metadata +61 -131
  153. data/docs/BeginLiveActivityRequest.md +0 -20
  154. data/docs/CancelNotificationSuccessResponse.md +0 -18
  155. data/docs/CreatePlayerSuccessResponse.md +0 -20
  156. data/docs/CreateSubscriptionRequestBody.md +0 -20
  157. data/docs/DeletePlayerNotFoundResponse.md +0 -18
  158. data/docs/DeleteSegmentNotFoundResponse.md +0 -18
  159. data/docs/DeleteSegmentSuccessResponse.md +0 -18
  160. data/docs/FilterExpressions.md +0 -26
  161. data/docs/InlineResponse2003.md +0 -18
  162. data/docs/InlineResponse201.md +0 -18
  163. data/docs/InvalidIdentifierError.md +0 -20
  164. data/docs/Player.md +0 -70
  165. data/docs/PlayerNotificationTarget.md +0 -40
  166. data/docs/PlayerNotificationTargetIncludeAliases.md +0 -18
  167. data/docs/PlayerSlice.md +0 -24
  168. data/docs/UpdatePlayerSuccessResponse.md +0 -18
  169. data/docs/UpdatePlayerTagsRequestBody.md +0 -18
  170. data/docs/UpdatePlayerTagsSuccessResponse.md +0 -18
  171. data/docs/UpdateSubscriptionRequestBody.md +0 -18
  172. data/docs/UserIdentityRequestBody.md +0 -18
  173. data/docs/UserIdentityResponse.md +0 -18
  174. data/docs/UserSubscriptionOptions.md +0 -18
  175. data/lib/onesignal/models/cancel_notification_success_response.rb +0 -219
  176. data/lib/onesignal/models/create_subscription_request_body.rb +0 -228
  177. data/lib/onesignal/models/delete_player_not_found_response.rb +0 -219
  178. data/lib/onesignal/models/delete_player_success_response.rb +0 -219
  179. data/lib/onesignal/models/delete_segment_not_found_response.rb +0 -219
  180. data/lib/onesignal/models/delete_segment_success_response.rb +0 -219
  181. data/lib/onesignal/models/filter_expressions.rb +0 -336
  182. data/lib/onesignal/models/generic_error_errors_inner.rb +0 -228
  183. data/lib/onesignal/models/inline_response2003.rb +0 -221
  184. data/lib/onesignal/models/invalid_identifier_error.rb +0 -234
  185. data/lib/onesignal/models/player.rb +0 -494
  186. data/lib/onesignal/models/player_notification_target_include_aliases.rb +0 -221
  187. data/lib/onesignal/models/update_player_tags_request_body.rb +0 -220
  188. data/lib/onesignal/models/update_player_tags_success_response.rb +0 -219
  189. data/lib/onesignal/models/update_subscription_request_body.rb +0 -219
  190. data/lib/onesignal/models/user_identity_request_body.rb +0 -221
  191. data/lib/onesignal/models/user_identity_response.rb +0 -221
  192. data/lib/onesignal/models/user_subscription_options.rb +0 -219
  193. data/spec/models/begin_live_activity_request_spec.rb +0 -40
  194. data/spec/models/cancel_notification_success_response_spec.rb +0 -34
  195. data/spec/models/create_subscription_request_body_spec.rb +0 -40
  196. data/spec/models/delete_player_not_found_response_spec.rb +0 -34
  197. data/spec/models/delete_segment_not_found_response_spec.rb +0 -34
  198. data/spec/models/delete_segment_success_response_spec.rb +0 -34
  199. data/spec/models/inline_response2003_spec.rb +0 -34
  200. data/spec/models/inline_response200_spec.rb +0 -34
  201. data/spec/models/invalid_identifier_error_spec.rb +0 -40
  202. data/spec/models/player_notification_target_include_aliases_spec.rb +0 -34
  203. data/spec/models/player_spec.rb +0 -190
  204. data/spec/models/rate_limiter_error_spec.rb +0 -34
  205. data/spec/models/update_player_success_response_spec.rb +0 -34
  206. data/spec/models/update_player_tags_request_body_spec.rb +0 -34
  207. data/spec/models/update_player_tags_success_response_spec.rb +0 -34
  208. data/spec/models/update_subscription_request_body_spec.rb +0 -34
  209. data/spec/models/user_identity_request_body_spec.rb +0 -34
  210. data/spec/models/user_subscription_options_spec.rb +0 -34
@@ -1,40 +0,0 @@
1
- # OneSignal::PlayerNotificationTarget
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **include_player_ids** | **Array<String>** | Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: [\"1dd608f2-c6a1-11e3-851d-000c2940e62c\"] Limit of 2,000 entries per REST API call | [optional] |
8
- | **include_external_user_ids** | **Array<String>** | 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. | [optional] |
9
- | **include_email_tokens** | **Array<String>** | 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 | [optional] |
10
- | **include_phone_numbers** | **Array<String>** | 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 | [optional] |
11
- | **include_ios_tokens** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids 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 | [optional] |
12
- | **include_wp_wns_uris** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids 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 | [optional] |
13
- | **include_amazon_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids 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 | [optional] |
14
- | **include_chrome_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids 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 | [optional] |
15
- | **include_chrome_web_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids 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 | [optional] |
16
- | **include_android_reg_ids** | **Array<String>** | Not Recommended: Please consider using include_player_ids or include_external_user_ids 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 | [optional] |
17
- | **include_aliases** | [**PlayerNotificationTargetIncludeAliases**](PlayerNotificationTargetIncludeAliases.md) | | [optional] |
18
- | **target_channel** | **String** | | [optional] |
19
-
20
- ## Example
21
-
22
- ```ruby
23
- require 'onesignal'
24
-
25
- instance = OneSignal::PlayerNotificationTarget.new(
26
- include_player_ids: null,
27
- include_external_user_ids: null,
28
- include_email_tokens: null,
29
- include_phone_numbers: null,
30
- include_ios_tokens: null,
31
- include_wp_wns_uris: null,
32
- include_amazon_reg_ids: null,
33
- include_chrome_reg_ids: null,
34
- include_chrome_web_reg_ids: null,
35
- include_android_reg_ids: null,
36
- include_aliases: null,
37
- target_channel: null
38
- )
39
- ```
40
-
@@ -1,18 +0,0 @@
1
- # OneSignal::PlayerNotificationTargetIncludeAliases
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **alias_label** | **Array<String>** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'onesignal'
13
-
14
- instance = OneSignal::PlayerNotificationTargetIncludeAliases.new(
15
- alias_label: null
16
- )
17
- ```
18
-
data/docs/PlayerSlice.md DELETED
@@ -1,24 +0,0 @@
1
- # OneSignal::PlayerSlice
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **total_count** | **Integer** | | [optional] |
8
- | **offset** | **Integer** | | [optional] |
9
- | **limit** | **Integer** | | [optional] |
10
- | **players** | [**Array<Player>**](Player.md) | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'onesignal'
16
-
17
- instance = OneSignal::PlayerSlice.new(
18
- total_count: null,
19
- offset: null,
20
- limit: null,
21
- players: null
22
- )
23
- ```
24
-
@@ -1,18 +0,0 @@
1
- # OneSignal::UpdatePlayerSuccessResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **success** | **Boolean** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'onesignal'
13
-
14
- instance = OneSignal::UpdatePlayerSuccessResponse.new(
15
- success: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # OneSignal::UpdatePlayerTagsRequestBody
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **tags** | **Object** | Custom tags for the device record. Only support string key value pairs. Does not support arrays or other nested objects. Example `{\"foo\":\"bar\",\"this\":\"that\"}`. Limitations: - 100 tags per call - Android SDK users: tags cannot be removed or changed via API if set through SDK sendTag methods. Recommended to only tag devices with 1 kilobyte of ata Please consider using your own Database to save more than 1 kilobyte of data. See: Internal Database & CRM | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'onesignal'
13
-
14
- instance = OneSignal::UpdatePlayerTagsRequestBody.new(
15
- tags: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # OneSignal::UpdatePlayerTagsSuccessResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **success** | **Boolean** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'onesignal'
13
-
14
- instance = OneSignal::UpdatePlayerTagsSuccessResponse.new(
15
- success: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # OneSignal::UpdateSubscriptionRequestBody
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **subscription** | [**SubscriptionObject**](SubscriptionObject.md) | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'onesignal'
13
-
14
- instance = OneSignal::UpdateSubscriptionRequestBody.new(
15
- subscription: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # OneSignal::UserIdentityRequestBody
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **identity** | **Hash<String, Object>** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'onesignal'
13
-
14
- instance = OneSignal::UserIdentityRequestBody.new(
15
- identity: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # OneSignal::UserIdentityResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **identity** | **Hash<String, Object>** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'onesignal'
13
-
14
- instance = OneSignal::UserIdentityResponse.new(
15
- identity: null
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # OneSignal::UserSubscriptionOptions
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **retain_previous_owner** | **Boolean** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'onesignal'
13
-
14
- instance = OneSignal::UserSubscriptionOptions.new(
15
- retain_previous_owner: null
16
- )
17
- ```
18
-
@@ -1,219 +0,0 @@
1
- =begin
2
- #OneSignal
3
-
4
- #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
-
6
- The version of the OpenAPI document: 1.4.1
7
- Contact: devrel@onesignal.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module OneSignal
17
- class CancelNotificationSuccessResponse
18
- attr_accessor :success
19
-
20
- # Attribute mapping from ruby-style variable name to JSON key.
21
- def self.attribute_map
22
- {
23
- :'success' => :'success'
24
- }
25
- end
26
-
27
- # Returns all the JSON keys this model knows about
28
- def self.acceptable_attributes
29
- attribute_map.values
30
- end
31
-
32
- # Attribute type mapping.
33
- def self.openapi_types
34
- {
35
- :'success' => :'Boolean'
36
- }
37
- end
38
-
39
- # List of attributes with nullable: true
40
- def self.openapi_nullable
41
- Set.new([
42
- ])
43
- end
44
-
45
- # Initializes the object
46
- # @param [Hash] attributes Model attributes in the form of hash
47
- def initialize(attributes = {})
48
- if (!attributes.is_a?(Hash))
49
- fail ArgumentError, "The input argument (attributes) must be a hash in `OneSignal::CancelNotificationSuccessResponse` initialize method"
50
- end
51
-
52
- # check to see if the attribute exists and convert string to symbol for hash key
53
- attributes = attributes.each_with_object({}) { |(k, v), h|
54
- if (!self.class.attribute_map.key?(k.to_sym))
55
- fail ArgumentError, "`#{k}` is not a valid attribute in `OneSignal::CancelNotificationSuccessResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
56
- end
57
- h[k.to_sym] = v
58
- }
59
-
60
- if attributes.key?(:'success')
61
- self.success = attributes[:'success']
62
- end
63
- end
64
-
65
- # Show invalid properties with the reasons. Usually used together with valid?
66
- # @return Array for valid properties with the reasons
67
- def list_invalid_properties
68
- invalid_properties = Array.new
69
- invalid_properties
70
- end
71
-
72
- # Check to see if the all the properties in the model are valid
73
- # @return true if the model is valid
74
- def valid?
75
- true
76
- end
77
-
78
- # Checks equality by comparing each attribute.
79
- # @param [Object] Object to be compared
80
- def ==(o)
81
- return true if self.equal?(o)
82
- self.class == o.class &&
83
- success == o.success
84
- end
85
-
86
- # @see the `==` method
87
- # @param [Object] Object to be compared
88
- def eql?(o)
89
- self == o
90
- end
91
-
92
- # Calculates hash code according to all attributes.
93
- # @return [Integer] Hash code
94
- def hash
95
- [success].hash
96
- end
97
-
98
- # Builds the object from hash
99
- # @param [Hash] attributes Model attributes in the form of hash
100
- # @return [Object] Returns the model itself
101
- def self.build_from_hash(attributes)
102
- new.build_from_hash(attributes)
103
- end
104
-
105
- # Builds the object from hash
106
- # @param [Hash] attributes Model attributes in the form of hash
107
- # @return [Object] Returns the model itself
108
- def build_from_hash(attributes)
109
- return nil unless attributes.is_a?(Hash)
110
- attributes = attributes.transform_keys(&:to_sym)
111
- self.class.openapi_types.each_pair do |key, type|
112
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
113
- self.send("#{key}=", nil)
114
- elsif type =~ /\AArray<(.*)>/i
115
- # check to ensure the input is an array given that the attribute
116
- # is documented as an array but the input is not
117
- if attributes[self.class.attribute_map[key]].is_a?(Array)
118
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
119
- end
120
- elsif !attributes[self.class.attribute_map[key]].nil?
121
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
122
- end
123
- end
124
-
125
- self
126
- end
127
-
128
- # Deserializes the data based on type
129
- # @param string type Data type
130
- # @param string value Value to be deserialized
131
- # @return [Object] Deserialized data
132
- def _deserialize(type, value)
133
- case type.to_sym
134
- when :Time
135
- Time.parse(value)
136
- when :Date
137
- Date.parse(value)
138
- when :String
139
- value.to_s
140
- when :Integer
141
- value.to_i
142
- when :Float
143
- value.to_f
144
- when :Boolean
145
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
146
- true
147
- else
148
- false
149
- end
150
- when :Object
151
- # generic object (usually a Hash), return directly
152
- value
153
- when /\AArray<(?<inner_type>.+)>\z/
154
- inner_type = Regexp.last_match[:inner_type]
155
- value.map { |v| _deserialize(inner_type, v) }
156
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
157
- k_type = Regexp.last_match[:k_type]
158
- v_type = Regexp.last_match[:v_type]
159
- {}.tap do |hash|
160
- value.each do |k, v|
161
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
162
- end
163
- end
164
- else # model
165
- # models (e.g. Pet) or oneOf
166
- klass = OneSignal.const_get(type)
167
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
168
- end
169
- end
170
-
171
- # Returns the string representation of the object
172
- # @return [String] String presentation of the object
173
- def to_s
174
- to_hash.to_s
175
- end
176
-
177
- # to_body is an alias to to_hash (backward compatibility)
178
- # @return [Hash] Returns the object in the form of hash
179
- def to_body
180
- to_hash
181
- end
182
-
183
- # Returns the object in the form of hash
184
- # @return [Hash] Returns the object in the form of hash
185
- def to_hash
186
- hash = {}
187
- self.class.attribute_map.each_pair do |attr, param|
188
- value = self.send(attr)
189
- if value.nil?
190
- is_nullable = self.class.openapi_nullable.include?(attr)
191
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
192
- end
193
-
194
- hash[param] = _to_hash(value)
195
- end
196
- hash
197
- end
198
-
199
- # Outputs non-array value in the form of hash
200
- # For object, use to_hash. Otherwise, just return the value
201
- # @param [Object] value Any valid value
202
- # @return [Hash] Returns the value in the form of hash
203
- def _to_hash(value)
204
- if value.is_a?(Array)
205
- value.compact.map { |v| _to_hash(v) }
206
- elsif value.is_a?(Hash)
207
- {}.tap do |hash|
208
- value.each { |k, v| hash[k] = _to_hash(v) }
209
- end
210
- elsif value.respond_to? :to_hash
211
- value.to_hash
212
- else
213
- value
214
- end
215
- end
216
-
217
- end
218
-
219
- end
@@ -1,228 +0,0 @@
1
- =begin
2
- #OneSignal
3
-
4
- #A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
5
-
6
- The version of the OpenAPI document: 1.4.1
7
- Contact: devrel@onesignal.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0-SNAPSHOT
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module OneSignal
17
- class CreateSubscriptionRequestBody
18
- attr_accessor :subscription
19
-
20
- attr_accessor :retain_previous_owner
21
-
22
- # Attribute mapping from ruby-style variable name to JSON key.
23
- def self.attribute_map
24
- {
25
- :'subscription' => :'subscription',
26
- :'retain_previous_owner' => :'retain_previous_owner'
27
- }
28
- end
29
-
30
- # Returns all the JSON keys this model knows about
31
- def self.acceptable_attributes
32
- attribute_map.values
33
- end
34
-
35
- # Attribute type mapping.
36
- def self.openapi_types
37
- {
38
- :'subscription' => :'SubscriptionObject',
39
- :'retain_previous_owner' => :'Boolean'
40
- }
41
- end
42
-
43
- # List of attributes with nullable: true
44
- def self.openapi_nullable
45
- Set.new([
46
- ])
47
- end
48
-
49
- # Initializes the object
50
- # @param [Hash] attributes Model attributes in the form of hash
51
- def initialize(attributes = {})
52
- if (!attributes.is_a?(Hash))
53
- fail ArgumentError, "The input argument (attributes) must be a hash in `OneSignal::CreateSubscriptionRequestBody` initialize method"
54
- end
55
-
56
- # check to see if the attribute exists and convert string to symbol for hash key
57
- attributes = attributes.each_with_object({}) { |(k, v), h|
58
- if (!self.class.attribute_map.key?(k.to_sym))
59
- fail ArgumentError, "`#{k}` is not a valid attribute in `OneSignal::CreateSubscriptionRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
60
- end
61
- h[k.to_sym] = v
62
- }
63
-
64
- if attributes.key?(:'subscription')
65
- self.subscription = attributes[:'subscription']
66
- end
67
-
68
- if attributes.key?(:'retain_previous_owner')
69
- self.retain_previous_owner = attributes[:'retain_previous_owner']
70
- end
71
- end
72
-
73
- # Show invalid properties with the reasons. Usually used together with valid?
74
- # @return Array for valid properties with the reasons
75
- def list_invalid_properties
76
- invalid_properties = Array.new
77
- invalid_properties
78
- end
79
-
80
- # Check to see if the all the properties in the model are valid
81
- # @return true if the model is valid
82
- def valid?
83
- true
84
- end
85
-
86
- # Checks equality by comparing each attribute.
87
- # @param [Object] Object to be compared
88
- def ==(o)
89
- return true if self.equal?(o)
90
- self.class == o.class &&
91
- subscription == o.subscription &&
92
- retain_previous_owner == o.retain_previous_owner
93
- end
94
-
95
- # @see the `==` method
96
- # @param [Object] Object to be compared
97
- def eql?(o)
98
- self == o
99
- end
100
-
101
- # Calculates hash code according to all attributes.
102
- # @return [Integer] Hash code
103
- def hash
104
- [subscription, retain_previous_owner].hash
105
- end
106
-
107
- # Builds the object from hash
108
- # @param [Hash] attributes Model attributes in the form of hash
109
- # @return [Object] Returns the model itself
110
- def self.build_from_hash(attributes)
111
- new.build_from_hash(attributes)
112
- end
113
-
114
- # Builds the object from hash
115
- # @param [Hash] attributes Model attributes in the form of hash
116
- # @return [Object] Returns the model itself
117
- def build_from_hash(attributes)
118
- return nil unless attributes.is_a?(Hash)
119
- attributes = attributes.transform_keys(&:to_sym)
120
- self.class.openapi_types.each_pair do |key, type|
121
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
122
- self.send("#{key}=", nil)
123
- elsif type =~ /\AArray<(.*)>/i
124
- # check to ensure the input is an array given that the attribute
125
- # is documented as an array but the input is not
126
- if attributes[self.class.attribute_map[key]].is_a?(Array)
127
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
128
- end
129
- elsif !attributes[self.class.attribute_map[key]].nil?
130
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
131
- end
132
- end
133
-
134
- self
135
- end
136
-
137
- # Deserializes the data based on type
138
- # @param string type Data type
139
- # @param string value Value to be deserialized
140
- # @return [Object] Deserialized data
141
- def _deserialize(type, value)
142
- case type.to_sym
143
- when :Time
144
- Time.parse(value)
145
- when :Date
146
- Date.parse(value)
147
- when :String
148
- value.to_s
149
- when :Integer
150
- value.to_i
151
- when :Float
152
- value.to_f
153
- when :Boolean
154
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
155
- true
156
- else
157
- false
158
- end
159
- when :Object
160
- # generic object (usually a Hash), return directly
161
- value
162
- when /\AArray<(?<inner_type>.+)>\z/
163
- inner_type = Regexp.last_match[:inner_type]
164
- value.map { |v| _deserialize(inner_type, v) }
165
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
166
- k_type = Regexp.last_match[:k_type]
167
- v_type = Regexp.last_match[:v_type]
168
- {}.tap do |hash|
169
- value.each do |k, v|
170
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
171
- end
172
- end
173
- else # model
174
- # models (e.g. Pet) or oneOf
175
- klass = OneSignal.const_get(type)
176
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
177
- end
178
- end
179
-
180
- # Returns the string representation of the object
181
- # @return [String] String presentation of the object
182
- def to_s
183
- to_hash.to_s
184
- end
185
-
186
- # to_body is an alias to to_hash (backward compatibility)
187
- # @return [Hash] Returns the object in the form of hash
188
- def to_body
189
- to_hash
190
- end
191
-
192
- # Returns the object in the form of hash
193
- # @return [Hash] Returns the object in the form of hash
194
- def to_hash
195
- hash = {}
196
- self.class.attribute_map.each_pair do |attr, param|
197
- value = self.send(attr)
198
- if value.nil?
199
- is_nullable = self.class.openapi_nullable.include?(attr)
200
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
201
- end
202
-
203
- hash[param] = _to_hash(value)
204
- end
205
- hash
206
- end
207
-
208
- # Outputs non-array value in the form of hash
209
- # For object, use to_hash. Otherwise, just return the value
210
- # @param [Object] value Any valid value
211
- # @return [Hash] Returns the value in the form of hash
212
- def _to_hash(value)
213
- if value.is_a?(Array)
214
- value.compact.map { |v| _to_hash(v) }
215
- elsif value.is_a?(Hash)
216
- {}.tap do |hash|
217
- value.each { |k, v| hash[k] = _to_hash(v) }
218
- end
219
- elsif value.respond_to? :to_hash
220
- value.to_hash
221
- else
222
- value
223
- end
224
- end
225
-
226
- end
227
-
228
- end