onesignal 0.3.0 → 1.0.0.beta1

data/docs/DeliveryData.md

@@ -0,0 +1,26 @@
+# OneSignal::DeliveryData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **successful** | **Integer** |  | [optional] |
+| **failed** | **Integer** |  | [optional] |
+| **errored** | **Integer** |  | [optional] |
+| **converted** | **Integer** |  | [optional] |
+| **received** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::DeliveryData.new(
+  successful: null,
+  failed: null,
+  errored: null,
+  converted: null,
+  received: null
+)
+```
+

data/docs/ExportPlayersRequestBody.md

@@ -0,0 +1,22 @@
+# OneSignal::ExportPlayersRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **extra_fields** | **Array<String>** | Additional fields that you wish to include. Currently supports location, country, rooted, notification_types, ip, external_user_id, web_auth, and web_p256. | [optional] |
+| **last_active_since** | **Integer** | Export all devices with a last_active timestamp greater than this time.  Unixtime in seconds. | [optional] |
+| **segment_name** | **String** | Export al ldevices belonging to the segment. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::ExportPlayersRequestBody.new(
+  extra_fields: null,
+  last_active_since: null,
+  segment_name: null
+)
+```
+

data/docs/Filter.md

@@ -0,0 +1,24 @@
+# OneSignal::Filter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | Name of the field to use as the first operand in the filter expression. |  |
+| **key** | **String** | If `field` is `tag`, this field is *required* to specify `key` inside the tags. | [optional] |
+| **value** | **String** | Constant value to use as the second operand in the filter expression.  This value is *required* when the relation operator is a binary operator. | [optional] |
+| **relation** | **String** | Operator of a filter expression. |  |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::Filter.new(
+  field: null,
+  key: null,
+  value: null,
+  relation: null
+)
+```
+

data/docs/FilterExpressions.md

@@ -0,0 +1,26 @@
+# OneSignal::FilterExpressions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | Name of the field to use as the first operand in the filter expression. |  |
+| **key** | **String** | If `field` is `tag`, this field is *required* to specify `key` inside the tags. | [optional] |
+| **value** | **String** | Constant value to use as the second operand in the filter expression.  This value is *required* when the relation operator is a binary operator. | [optional] |
+| **relation** | **String** | Operator of a filter expression. |  |
+| **operator** | **String** | Strictly, this must be either `\"OR\"`, or `\"AND\"`.  It can be used to compose Filters as part of a Filters object. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::FilterExpressions.new(
+  field: null,
+  key: null,
+  value: null,
+  relation: null,
+  operator: null
+)
+```
+

data/docs/FilterNotificationTarget.md

@@ -0,0 +1,40 @@
+# OneSignal::FilterNotificationTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **last_session** | **String** | relation = \">\" or \"<\" hours_ago = number of hours before or after the users last session. Example: \"1.1\"  | [optional] |
+| **first_session** | **String** | relation = \">\" or \"<\" hours_ago = number of hours before or after the users first session. Example: \"1.1\"  | [optional] |
+| **session_count** | **String** | relation = \">\", \"<\", \"=\" or \"!=\" value = number sessions. Example: \"1\"  | [optional] |
+| **session_time** | **String** | relation = \">\", \"<\", \"=\" or \"!=\" value = Time in seconds the user has been in your app. Example: \"3600\"  | [optional] |
+| **amount_spent** | **String** | relation = \">\", \"<\", or \"=\" value = Amount in USD a user has spent on IAP (In App Purchases). Example: \"0.99\"  | [optional] |
+| **bought_sku** | **String** | relation = \">\", \"<\" or \"=\" key = SKU purchased in your app as an IAP (In App Purchases). Example: \"com.domain.100coinpack\" value = value of SKU to compare to. Example: \"0.99\"  | [optional] |
+| **tag** | **String** | relation = \">\", \"<\", \"=\", \"!=\", \"exists\", \"not_exists\", \"time_elapsed_gt\" (paid plan only) or \"time_elapsed_lt\" (paid plan only) See Time Operators key = Tag key to compare. value = Tag value to compare. Not required for \"exists\" or \"not_exists\". Example: See Formatting Filters  | [optional] |
+| **language** | **String** | relation = \"=\" or \"!=\" value = 2 character language code. Example: \"en\". For a list of all language codes see Language & Localization.  | [optional] |
+| **app_version** | **String** | relation = \">\", \"<\", \"=\" or \"!=\" value = app version. Example: \"1.0.0\"  | [optional] |
+| **location** | **String** | radius = in meters lat = latitude long = longitude  | [optional] |
+| **email** | **String** | value = email address Only for sending Push Notifications Use this for targeting push subscribers associated with an email set with all SDK setEmail methods To send emails to specific email addresses use include_email_tokens parameter  | [optional] |
+| **country** | **String** | relation = \"=\" value = 2-digit Country code Example: \"field\": \"country\", \"relation\": \"=\", \"value\", \"US\"  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::FilterNotificationTarget.new(
+  last_session: null,
+  first_session: null,
+  session_count: null,
+  session_time: null,
+  amount_spent: null,
+  bought_sku: null,
+  tag: null,
+  language: null,
+  app_version: null,
+  location: null,
+  email: null,
+  country: null
+)
+```
+

data/docs/GetNotificationRequestBody.md

@@ -0,0 +1,22 @@
+# OneSignal::GetNotificationRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | **String** | -> \"sent\" - All the devices by player_id that were sent the specified notification_id.  Notifications targeting under 1000 recipients will not have \"sent\" events recorded, but will show \"clicked\" events. \"clicked\" - All the devices by `player_id` that clicked the specified notification_id. | [optional] |
+| **email** | **String** | The email address you would like the report sent. | [optional] |
+| **app_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::GetNotificationRequestBody.new(
+  events: null,
+  email: null,
+  app_id: null
+)
+```
+

data/docs/InlineResponse200.md

@@ -0,0 +1,24 @@
+# OneSignal::InlineResponse200
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **recipients** | **Integer** | Estimated number of subscribers targetted by notification. |  |
+| **external_id** | **String** |  | [optional] |
+| **errors** | [**OneOfobjectarray**](OneOfobjectarray.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse200.new(
+  id: null,
+  recipients: null,
+  external_id: null,
+  errors: null
+)
+```
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,18 @@
+# OneSignal::InlineResponse2001
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse2001.new(
+  success: null
+)
+```
+

data/docs/InlineResponse2002.md

@@ -0,0 +1,20 @@
+# OneSignal::InlineResponse2002
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **String** |  | [optional] |
+| **destination_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse2002.new(
+  success: null,
+  destination_url: null
+)
+```
+

data/docs/InlineResponse2003.md

@@ -0,0 +1,18 @@
+# OneSignal::InlineResponse2003
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse2003.new(
+  success: null
+)
+```
+

data/docs/InlineResponse2004.md

@@ -0,0 +1,20 @@
+# OneSignal::InlineResponse2004
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse2004.new(
+  success: null,
+  id: null
+)
+```
+

data/docs/InlineResponse2005.md

@@ -0,0 +1,18 @@
+# OneSignal::InlineResponse2005
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csv_file_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse2005.new(
+  csv_file_url: null
+)
+```
+

data/docs/InlineResponse201.md

@@ -0,0 +1,20 @@
+# OneSignal::InlineResponse201
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **id** | **String** | UUID of created segment | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse201.new(
+  success: null,
+  id: null
+)
+```
+

data/docs/InlineResponse400.md

@@ -0,0 +1,18 @@
+# OneSignal::InlineResponse400
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse400.new(
+  errors: null
+)
+```
+

data/docs/InlineResponse4001.md

@@ -0,0 +1,20 @@
+# OneSignal::InlineResponse4001
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **String** |  | [optional] |
+| **errors** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse4001.new(
+  success: null,
+  errors: null
+)
+```
+

data/docs/InlineResponse4002.md

@@ -0,0 +1,18 @@
+# OneSignal::InlineResponse4002
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **erorrs** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse4002.new(
+  erorrs: null
+)
+```
+

data/docs/InlineResponse409.md

@@ -0,0 +1,20 @@
+# OneSignal::InlineResponse409
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **errors** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::InlineResponse409.new(
+  success: null,
+  errors: null
+)
+```
+