onesignal 0.2.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (155) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +14 -0
  3. data/Gemfile +6 -1
  4. data/LICENSE +6 -3
  5. data/README.md +144 -99
  6. data/RELEASE_INSTRUCTIONS.md +11 -0
  7. data/Rakefile +8 -8
  8. data/docs/App.md +76 -0
  9. data/docs/Button.md +22 -0
  10. data/docs/DefaultApi.md +1394 -0
  11. data/docs/DeliveryData.md +26 -0
  12. data/docs/ExportPlayersRequestBody.md +22 -0
  13. data/docs/Filter.md +24 -0
  14. data/docs/FilterExpressions.md +26 -0
  15. data/docs/FilterNotificationTarget.md +40 -0
  16. data/docs/GetNotificationRequestBody.md +22 -0
  17. data/docs/InlineResponse200.md +24 -0
  18. data/docs/InlineResponse2001.md +18 -0
  19. data/docs/InlineResponse2002.md +20 -0
  20. data/docs/InlineResponse2005.md +20 -0
  21. data/docs/InlineResponse2007.md +18 -0
  22. data/docs/InlineResponse2008.md +18 -0
  23. data/docs/InlineResponse201.md +20 -0
  24. data/docs/InlineResponse400.md +18 -0
  25. data/docs/InlineResponse4001.md +20 -0
  26. data/docs/InlineResponse4002.md +20 -0
  27. data/docs/InlineResponse4003.md +18 -0
  28. data/docs/InvalidIdentifierError.md +20 -0
  29. data/docs/Notification.md +240 -0
  30. data/docs/Notification200Errors.md +49 -0
  31. data/docs/NotificationAllOf.md +192 -0
  32. data/docs/NotificationAllOfAndroidBackgroundLayout.md +22 -0
  33. data/docs/NotificationSlice.md +24 -0
  34. data/docs/NotificationTarget.md +64 -0
  35. data/docs/NotificationWithMeta.md +260 -0
  36. data/docs/NotificationWithMetaAllOf.md +38 -0
  37. data/docs/Operator.md +18 -0
  38. data/docs/OutcomeData.md +22 -0
  39. data/docs/OutcomesData.md +18 -0
  40. data/docs/PlatformDeliveryData.md +28 -0
  41. data/docs/Player.md +70 -0
  42. data/docs/PlayerNotificationTarget.md +36 -0
  43. data/docs/PlayerSlice.md +24 -0
  44. data/docs/Purchase.md +22 -0
  45. data/docs/Segment.md +22 -0
  46. data/docs/SegmentNotificationTarget.md +20 -0
  47. data/docs/StringMap.md +102 -0
  48. data/docs/UpdatePlayerTagsRequestBody.md +18 -0
  49. data/lib/onesignal/api/default_api.rb +1365 -0
  50. data/lib/onesignal/api_client.rb +393 -0
  51. data/lib/onesignal/api_error.rb +57 -0
  52. data/lib/onesignal/configuration.rb +245 -0
  53. data/lib/onesignal/models/app.rb +519 -20
  54. data/lib/onesignal/models/button.rb +242 -0
  55. data/lib/onesignal/models/delivery_data.rb +260 -0
  56. data/lib/onesignal/models/export_players_request_body.rb +242 -0
  57. data/lib/onesignal/models/filter.rb +294 -0
  58. data/lib/onesignal/models/filter_expressions.rb +336 -0
  59. data/lib/onesignal/models/filter_notification_target.rb +330 -0
  60. data/lib/onesignal/models/get_notification_request_body.rb +273 -0
  61. data/lib/onesignal/models/inline_response200.rb +257 -0
  62. data/lib/onesignal/models/inline_response2001.rb +219 -0
  63. data/lib/onesignal/models/inline_response2002.rb +228 -0
  64. data/lib/onesignal/models/inline_response2005.rb +228 -0
  65. data/lib/onesignal/models/inline_response2007.rb +219 -0
  66. data/lib/onesignal/models/inline_response2008.rb +219 -0
  67. data/lib/onesignal/models/inline_response201.rb +229 -0
  68. data/lib/onesignal/models/inline_response400.rb +221 -0
  69. data/lib/onesignal/models/inline_response4001.rb +230 -0
  70. data/lib/onesignal/models/inline_response4002.rb +230 -0
  71. data/lib/onesignal/models/inline_response4003.rb +221 -0
  72. data/lib/onesignal/models/invalid_identifier_error.rb +234 -0
  73. data/lib/onesignal/models/notification.rb +1414 -9
  74. data/lib/onesignal/models/notification200_errors.rb +105 -0
  75. data/lib/onesignal/models/notification_all_of.rb +1144 -0
  76. data/lib/onesignal/models/notification_all_of_android_background_layout.rb +241 -0
  77. data/lib/onesignal/models/notification_slice.rb +248 -0
  78. data/lib/onesignal/models/notification_target.rb +495 -0
  79. data/lib/onesignal/models/notification_with_meta.rb +1526 -0
  80. data/lib/onesignal/models/notification_with_meta_all_of.rb +322 -0
  81. data/lib/onesignal/models/operator.rb +254 -0
  82. data/lib/onesignal/models/outcome_data.rb +286 -0
  83. data/lib/onesignal/models/outcomes_data.rb +221 -0
  84. data/lib/onesignal/models/platform_delivery_data.rb +265 -0
  85. data/lib/onesignal/models/player.rb +480 -13
  86. data/lib/onesignal/models/player_notification_target.rb +330 -0
  87. data/lib/onesignal/models/player_slice.rb +248 -0
  88. data/lib/onesignal/models/purchase.rb +255 -0
  89. data/lib/onesignal/models/segment.rb +252 -0
  90. data/lib/onesignal/models/segment_notification_target.rb +234 -0
  91. data/lib/onesignal/models/string_map.rb +640 -0
  92. data/lib/onesignal/models/update_player_tags_request_body.rb +220 -0
  93. data/lib/onesignal/version.rb +13 -1
  94. data/lib/onesignal.rb +73 -16
  95. data/onesignal.gemspec +37 -27
  96. data/spec/api/default_api_spec.rb +285 -0
  97. data/spec/api_client_spec.rb +226 -0
  98. data/spec/configuration_spec.rb +42 -0
  99. data/spec/models/app_spec.rb +212 -0
  100. data/spec/models/button_spec.rb +46 -0
  101. data/spec/models/delivery_data_spec.rb +58 -0
  102. data/spec/models/export_players_request_body_spec.rb +46 -0
  103. data/spec/models/filter_expressions_spec.rb +66 -0
  104. data/spec/models/filter_notification_target_spec.rb +100 -0
  105. data/spec/models/filter_spec.rb +56 -0
  106. data/spec/models/get_notification_request_body_spec.rb +50 -0
  107. data/spec/models/inline_response2001_spec.rb +34 -0
  108. data/spec/models/inline_response2002_spec.rb +40 -0
  109. data/spec/models/inline_response2005_spec.rb +40 -0
  110. data/spec/models/inline_response2007_spec.rb +34 -0
  111. data/spec/models/inline_response2008_spec.rb +34 -0
  112. data/spec/models/inline_response200_spec.rb +52 -0
  113. data/spec/models/inline_response201_spec.rb +40 -0
  114. data/spec/models/inline_response4001_spec.rb +40 -0
  115. data/spec/models/inline_response4002_spec.rb +40 -0
  116. data/spec/models/inline_response4003_spec.rb +34 -0
  117. data/spec/models/inline_response400_spec.rb +34 -0
  118. data/spec/models/invalid_identifier_error_spec.rb +40 -0
  119. data/spec/models/notification200_errors_spec.rb +31 -0
  120. data/spec/models/notification_all_of_android_background_layout_spec.rb +46 -0
  121. data/spec/models/notification_all_of_spec.rb +560 -0
  122. data/spec/models/notification_slice_spec.rb +52 -0
  123. data/spec/models/notification_spec.rb +704 -0
  124. data/spec/models/notification_target_spec.rb +172 -0
  125. data/spec/models/notification_with_meta_all_of_spec.rb +94 -0
  126. data/spec/models/notification_with_meta_spec.rb +764 -0
  127. data/spec/models/operator_spec.rb +38 -0
  128. data/spec/models/outcome_data_spec.rb +50 -0
  129. data/spec/models/outcomes_data_spec.rb +34 -0
  130. data/spec/models/platform_delivery_data_spec.rb +64 -0
  131. data/spec/models/player_notification_target_spec.rb +88 -0
  132. data/spec/models/player_slice_spec.rb +52 -0
  133. data/spec/models/player_spec.rb +190 -0
  134. data/spec/models/purchase_spec.rb +46 -0
  135. data/spec/models/segment_notification_target_spec.rb +40 -0
  136. data/spec/models/segment_spec.rb +46 -0
  137. data/spec/models/string_map_spec.rb +286 -0
  138. data/spec/models/update_player_tags_request_body_spec.rb +34 -0
  139. data/spec/spec_helper.rb +111 -0
  140. metadata +203 -64
  141. data/.gitignore +0 -10
  142. data/.rubocop.yml +0 -17
  143. data/.travis.yml +0 -16
  144. data/CODE_OF_CONDUCT.md +0 -49
  145. data/bin/console +0 -14
  146. data/bin/setup +0 -8
  147. data/lib/onesignal/app_id_missing_error.rb +0 -7
  148. data/lib/onesignal/client.rb +0 -44
  149. data/lib/onesignal/models/base_model.rb +0 -19
  150. data/lib/onesignal/request.rb +0 -94
  151. data/lib/onesignal/request_error.rb +0 -21
  152. data/lib/onesignal/resources/app_resource.rb +0 -27
  153. data/lib/onesignal/resources/base_resource.rb +0 -35
  154. data/lib/onesignal/resources/notification_resource.rb +0 -33
  155. data/lib/onesignal/resources/player_resource.rb +0 -53
data/docs/PlayerSlice.md ADDED
@@ -0,0 +1,24 @@
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
+
data/docs/Purchase.md ADDED
@@ -0,0 +1,22 @@
1
+ # OneSignal::Purchase
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sku** | **String** | The unique identifier of the purchased item. | |
8
+ | **amount** | **Float** | The amount, in USD, spent purchasing the item. | |
9
+ | **iso** | **String** | The 3-letter ISO 4217 currency code. Required for correct storage and conversion of amount. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'onesignal'
15
+
16
+ instance = OneSignal::Purchase.new(
17
+ sku: null,
18
+ amount: null,
19
+ iso: null
20
+ )
21
+ ```
22
+
data/docs/Segment.md ADDED
@@ -0,0 +1,22 @@
1
+ # OneSignal::Segment
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | UUID of the segment. If left empty, it will be assigned automaticaly. | [optional] |
8
+ | **name** | **String** | Name of the segment. You'll see this name on the Web UI. | |
9
+ | **filters** | [**Array<FilterExpressions>**](FilterExpressions.md) | Filter or operators the segment will have. For a list of available filters with details, please see Send to Users Based on Filters. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'onesignal'
15
+
16
+ instance = OneSignal::Segment.new(
17
+ id: null,
18
+ name: null,
19
+ filters: null
20
+ )
21
+ ```
22
+
data/docs/SegmentNotificationTarget.md ADDED
@@ -0,0 +1,20 @@
1
+ # OneSignal::SegmentNotificationTarget
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **included_segments** | **Array<String>** | The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: [\"Active Users\", \"Inactive Users\"] | [optional] |
8
+ | **excluded_segments** | **Array<String>** | 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\"] | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'onesignal'
14
+
15
+ instance = OneSignal::SegmentNotificationTarget.new(
16
+ included_segments: null,
17
+ excluded_segments: null
18
+ )
19
+ ```
20
+
data/docs/StringMap.md ADDED
@@ -0,0 +1,102 @@
1
+ # OneSignal::StringMap
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **en** | **String** | Text in English. Will be used as a fallback | [optional] |
8
+ | **ar** | **String** | Text in Arabic. | [optional] |
9
+ | **bs** | **String** | Text in Bosnian. | [optional] |
10
+ | **bg** | **String** | Text in Bulgarian. | [optional] |
11
+ | **ca** | **String** | Text in Catalan. | [optional] |
12
+ | **zh_hans** | **String** | Text in Chinese (Simplified). | [optional] |
13
+ | **zh_hant** | **String** | Text in Chinese (Traditional). | [optional] |
14
+ | **zh** | **String** | Alias for zh-Hans. | [optional] |
15
+ | **hr** | **String** | Text in Croatian. | [optional] |
16
+ | **cs** | **String** | Text in Czech. | [optional] |
17
+ | **da** | **String** | Text in Danish. | [optional] |
18
+ | **nl** | **String** | Text in Dutch. | [optional] |
19
+ | **et** | **String** | Text in Estonian. | [optional] |
20
+ | **fi** | **String** | Text in Finnish. | [optional] |
21
+ | **fr** | **String** | Text in French. | [optional] |
22
+ | **ka** | **String** | Text in Georgian. | [optional] |
23
+ | **de** | **String** | Text in German. | [optional] |
24
+ | **el** | **String** | Text in Greek. | [optional] |
25
+ | **hi** | **String** | Text in Hindi. | [optional] |
26
+ | **he** | **String** | Text in Hebrew. | [optional] |
27
+ | **hu** | **String** | Text in Hungarian. | [optional] |
28
+ | **id** | **String** | Text in Indonesian. | [optional] |
29
+ | **it** | **String** | Text in Italian. | [optional] |
30
+ | **ja** | **String** | Text in Japanese. | [optional] |
31
+ | **ko** | **String** | Text in Korean. | [optional] |
32
+ | **lv** | **String** | Text in Latvian. | [optional] |
33
+ | **lt** | **String** | Text in Lithuanian. | [optional] |
34
+ | **ms** | **String** | Text in Malay. | [optional] |
35
+ | **nb** | **String** | Text in Norwegian. | [optional] |
36
+ | **pl** | **String** | Text in Polish. | [optional] |
37
+ | **fa** | **String** | Text in Persian. | [optional] |
38
+ | **pt** | **String** | Text in Portugese. | [optional] |
39
+ | **pa** | **String** | Text in Punjabi. | [optional] |
40
+ | **ro** | **String** | Text in Romanian. | [optional] |
41
+ | **ru** | **String** | Text in Russian. | [optional] |
42
+ | **sr** | **String** | Text in Serbian. | [optional] |
43
+ | **sk** | **String** | Text in Slovak. | [optional] |
44
+ | **es** | **String** | Text in Spanish. | [optional] |
45
+ | **sv** | **String** | Text in Swedish. | [optional] |
46
+ | **th** | **String** | Text in Thai. | [optional] |
47
+ | **tr** | **String** | Text in Turkish. | [optional] |
48
+ | **uk** | **String** | Text in Ukrainian. | [optional] |
49
+ | **vi** | **String** | Text in Vietnamese. | [optional] |
50
+
51
+ ## Example
52
+
53
+ ```ruby
54
+ require 'onesignal'
55
+
56
+ instance = OneSignal::StringMap.new(
57
+ en: null,
58
+ ar: null,
59
+ bs: null,
60
+ bg: null,
61
+ ca: null,
62
+ zh_hans: null,
63
+ zh_hant: null,
64
+ zh: null,
65
+ hr: null,
66
+ cs: null,
67
+ da: null,
68
+ nl: null,
69
+ et: null,
70
+ fi: null,
71
+ fr: null,
72
+ ka: null,
73
+ de: null,
74
+ el: null,
75
+ hi: null,
76
+ he: null,
77
+ hu: null,
78
+ id: null,
79
+ it: null,
80
+ ja: null,
81
+ ko: null,
82
+ lv: null,
83
+ lt: null,
84
+ ms: null,
85
+ nb: null,
86
+ pl: null,
87
+ fa: null,
88
+ pt: null,
89
+ pa: null,
90
+ ro: null,
91
+ ru: null,
92
+ sr: null,
93
+ sk: null,
94
+ es: null,
95
+ sv: null,
96
+ th: null,
97
+ tr: null,
98
+ uk: null,
99
+ vi: null
100
+ )
101
+ ```
102
+
data/docs/UpdatePlayerTagsRequestBody.md ADDED
@@ -0,0 +1,18 @@
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
+