onesignal 1.0.0.beta1 → 2.2.0

data/docs/NotificationWithMetaAllOf.md

@@ -0,0 +1,38 @@
+# OneSignal::NotificationWithMetaAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remaining** | **Integer** | Number of notifications that have not been sent out yet. This can mean either our system is still processing the notification or you have delayed options set. | [optional] |
+| **successful** | **Integer** | Number of notifications that were successfully delivered. | [optional] |
+| **failed** | **Integer** | Number of notifications that could not be delivered due to those devices being unsubscribed. | [optional] |
+| **errored** | **Integer** | Number of notifications that could not be delivered due to an error. You can find more information by viewing the notification in the dashboard. | [optional] |
+| **converted** | **Integer** | Number of users who have clicked / tapped on your notification. | [optional] |
+| **queued_at** | **Integer** | Unix timestamp indicating when the notification was created. | [optional] |
+| **send_after** | **Integer** | Unix timestamp indicating when notification delivery should begin. | [optional] |
+| **completed_at** | **Integer** | Unix timestamp indicating when notification delivery completed. The delivery duration from start to finish can be calculated with completed_at - send_after. | [optional] |
+| **platform_delivery_stats** | [**PlatformDeliveryData**](PlatformDeliveryData.md) |  | [optional] |
+| **received** | **Integer** | Confirmed Deliveries number of devices that received the push notification. Paid Feature Only. Free accounts will see 0. | [optional] |
+| **throttle_rate_per_minute** | **Integer** | number of push notifications sent per minute. Paid Feature Only. If throttling is not enabled for the app or the notification, and for free accounts, null is returned. Refer to Throttling for more details. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::NotificationWithMetaAllOf.new(
+  remaining: null,
+  successful: null,
+  failed: null,
+  errored: null,
+  converted: null,
+  queued_at: null,
+  send_after: null,
+  completed_at: null,
+  platform_delivery_stats: null,
+  received: null,
+  throttle_rate_per_minute: null
+)
+```
+

data/docs/OutcomesData.md

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

data/docs/PlatformDeliveryData.md

@@ -10,6 +10,8 @@
 | **safari_web_push** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
 | **android** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
 | **ios** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
+| **sms** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
+| **email** | [**DeliveryData**](DeliveryData.md) |  | [optional] |
 
 ## Example
 
@@ -22,7 +24,9 @@ instance = OneSignal::PlatformDeliveryData.new(
   firefox_web_push: null,
   safari_web_push: null,
   android: null,
-  ios: null
+  ios: null,
+  sms: null,
+  email: null
 )
 ```
 

data/docs/PlatformDeliveryDataEmailAllOf.md

@@ -0,0 +1,30 @@
+# OneSignal::PlatformDeliveryDataEmailAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **opened** | **Integer** | Number of times an email has been opened. | [optional] |
+| **unique_opens** | **Integer** | Number of unique recipients who have opened your email. | [optional] |
+| **clicks** | **Integer** | Number of clicked links from your email. This can include the recipient clicking email links multiple times. | [optional] |
+| **unique_clicks** | **Integer** | Number of unique clicks that your recipients have made on links from your email. | [optional] |
+| **bounced** | **Integer** | Number of recipients who registered as a hard or soft bounce and didn't receive your email. | [optional] |
+| **reported_spam** | **Integer** | Number of recipients who reported this email as spam. | [optional] |
+| **unsubscribed** | **Integer** | Number of recipients who opted out of your emails using the unsubscribe link in this email. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::PlatformDeliveryDataEmailAllOf.new(
+  opened: null,
+  unique_opens: null,
+  clicks: null,
+  unique_clicks: null,
+  bounced: null,
+  reported_spam: null,
+  unsubscribed: null
+)
+```
+

data/docs/PlatformDeliveryDataSmsAllOf.md

@@ -0,0 +1,22 @@
+# OneSignal::PlatformDeliveryDataSmsAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider_successful** | **Integer** | Number of messages reported as delivered successfully by the SMS service provider. | [optional] |
+| **provider_failed** | **Integer** | Number of recipients who didn't receive your message as reported by the SMS service provider. | [optional] |
+| **provider_errored** | **Integer** | Number of errors reported by the SMS service provider. | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::PlatformDeliveryDataSmsAllOf.new(
+  provider_successful: null,
+  provider_failed: null,
+  provider_errored: null
+)
+```
+

data/docs/Player.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The device's OneSignal ID | [readonly] |
+| **id** | **String** | The device's OneSignal ID | [optional][readonly] |
 | **invalid_identifier** | **Boolean** | If true, this is the equivalent of a user being Unsubscribed | [optional][readonly] |
-| **app_id** | **String** |  |  |
+| **app_id** | **String** |  | [optional] |
 | **device_type** | **Integer** | Required The device's platform:   0 = iOS   1 = Android   2 = Amazon   3 = WindowsPhone (MPNS)   4 = Chrome Apps / Extensions   5 = Chrome Web Push   6 = Windows (WNS)   7 = Safari   8 = Firefox   9 = MacOS   10 = Alexa   11 = Email   13 = For Huawei App Gallery Builds SDK Setup. Not for Huawei Devices using FCM   14 = SMS  |  |
 | **external_user_id** | **String** | a custom user ID | [optional] |
 | **external_user_id_auth_hash** | **String** | Only required if you have enabled Identity Verification and device_type is NOT 11 email. | [optional] |
@@ -21,7 +21,7 @@
 | **sdk** | **String** | Name and version of the sdk/plugin that's calling this API method (if any) | [optional] |
 | **session_count** | **Integer** | Number of times the user has played the game, defaults to 1 | [optional] |
 | **tags** | **Object** | Custom tags for the player. Only support string and integer key value pairs. Does not support arrays or other nested objects. Setting a tag value to null or an empty string will remove the tag. 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 data Please consider using your own Database to save more than 1 kilobyte of data. See: Internal Database & CRM  | [optional] |
-| **amount_spent** | **String** | Amount the user has spent in USD, up to two decimal places | [optional] |
+| **amount_spent** | **Float** | Amount the user has spent in USD, up to two decimal places | [optional] |
 | **created_at** | **Integer** | Unixtime when the player joined the game | [optional] |
 | **playtime** | **Integer** | Seconds player was running your app. | [optional] |
 | **badge_count** | **Integer** | Current iOS badge count displayed on the app icon NOTE: Not supported for apps created after June 2018, since badge count for apps created after this date are handled on the client.  | [optional] |

data/docs/PlayerNotificationTarget.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **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] |
-| **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] |
+| **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] |
 | **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] |
 | **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] |
 | **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] |
@@ -14,6 +14,8 @@
 | **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] |
 | **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] |
 | **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] |
+| **include_aliases** | [**PlayerNotificationTargetIncludeAliases**](PlayerNotificationTargetIncludeAliases.md) |  | [optional] |
+| **target_channel** | **String** |  | [optional] |
 
 ## Example
 
@@ -30,7 +32,9 @@ instance = OneSignal::PlayerNotificationTarget.new(
   include_amazon_reg_ids: null,
   include_chrome_reg_ids: null,
   include_chrome_web_reg_ids: null,
-  include_android_reg_ids: null
+  include_android_reg_ids: null,
+  include_aliases: null,
+  target_channel: null
 )
 ```
 

data/docs/PlayerNotificationTargetIncludeAliases.md

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

data/docs/PropertiesDeltas.md

@@ -0,0 +1,22 @@
+# OneSignal::PropertiesDeltas
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_time** | **Float** |  | [optional] |
+| **session_count** | **Float** |  | [optional] |
+| **purchases** | [**Array<Purchase>**](Purchase.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::PropertiesDeltas.new(
+  session_time: null,
+  session_count: null,
+  purchases: null
+)
+```
+

data/docs/PropertiesObject.md

@@ -0,0 +1,38 @@
+# OneSignal::PropertiesObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tags** | **Hash<String, Object>** |  | [optional] |
+| **language** | **String** |  | [optional] |
+| **timezone_id** | **String** |  | [optional] |
+| **lat** | **Float** |  | [optional] |
+| **long** | **Float** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **first_active** | **Float** |  | [optional] |
+| **last_active** | **Float** |  | [optional] |
+| **amount_spent** | **Float** |  | [optional] |
+| **purchases** | [**Array<Purchase>**](Purchase.md) |  | [optional] |
+| **ip** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::PropertiesObject.new(
+  tags: null,
+  language: null,
+  timezone_id: null,
+  lat: null,
+  long: null,
+  country: null,
+  first_active: null,
+  last_active: null,
+  amount_spent: null,
+  purchases: null,
+  ip: null
+)
+```
+

data/docs/Purchase.md

@@ -5,8 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **sku** | **String** | The unique identifier of the purchased item. |  |
-| **amount** | **Float** | The amount, in USD, spent purchasing the item. |  |
+| **amount** | **String** | The amount, in USD, spent purchasing the item. |  |
 | **iso** | **String** | The 3-letter ISO 4217 currency code. Required for correct storage and conversion of amount. |  |
+| **count** | **Float** |  | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'onesignal'
 instance = OneSignal::Purchase.new(
   sku: null,
   amount: null,
-  iso: null
+  iso: null,
+  count: null
 )
 ```
 

data/docs/RateLimiterError.md

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

data/docs/StringMap.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **en** | **String** | Text in English.  Will be used as a fallback |  |
+| **en** | **String** | Text in English.  Will be used as a fallback | [optional] |
 | **ar** | **String** | Text in Arabic. | [optional] |
 | **bs** | **String** | Text in Bosnian. | [optional] |
 | **bg** | **String** | Text in Bulgarian. | [optional] |

data/docs/SubscriptionObject.md

@@ -0,0 +1,50 @@
+# OneSignal::SubscriptionObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **token** | **String** |  | [optional] |
+| **enabled** | **Boolean** |  | [optional] |
+| **notification_types** | **Float** |  | [optional] |
+| **session_time** | **Float** |  | [optional] |
+| **session_count** | **Float** |  | [optional] |
+| **sdk** | **String** |  | [optional] |
+| **device_model** | **String** |  | [optional] |
+| **device_os** | **String** |  | [optional] |
+| **rooted** | **Boolean** |  | [optional] |
+| **test_type** | **Float** |  | [optional] |
+| **app_version** | **String** |  | [optional] |
+| **net_type** | **Float** |  | [optional] |
+| **carrier** | **String** |  | [optional] |
+| **web_auth** | **String** |  | [optional] |
+| **web_p256** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::SubscriptionObject.new(
+  id: null,
+  type: null,
+  token: null,
+  enabled: null,
+  notification_types: null,
+  session_time: null,
+  session_count: null,
+  sdk: null,
+  device_model: null,
+  device_os: null,
+  rooted: null,
+  test_type: null,
+  app_version: null,
+  net_type: null,
+  carrier: null,
+  web_auth: null,
+  web_p256: null
+)
+```
+

data/docs/TransferSubscriptionRequestBody.md

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

data/docs/UpdateLiveActivityRequest.md

@@ -0,0 +1,24 @@
+# OneSignal::UpdateLiveActivityRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Type of live activity |  |
+| **event** | **String** |  |  |
+| **event_updates** | **Object** |  |  |
+| **dismiss_at** | **Float** | Timestamp; only allowed if event is \"end\" | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::UpdateLiveActivityRequest.new(
+  name: null,
+  event: null,
+  event_updates: null,
+  dismiss_at: null
+)
+```
+

data/docs/UpdateLiveActivitySuccessResponse.md

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

data/docs/UpdatePlayerSuccessResponse.md

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

data/docs/UpdatePlayerTagsSuccessResponse.md

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

data/docs/UpdateSubscriptionRequestBody.md

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

data/docs/UpdateUserRequest.md

@@ -0,0 +1,22 @@
+# OneSignal::UpdateUserRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **properties** | [**PropertiesObject**](PropertiesObject.md) |  | [optional] |
+| **refresh_device_metadata** | **Boolean** |  | [optional][default to false] |
+| **deltas** | [**PropertiesDeltas**](PropertiesDeltas.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::UpdateUserRequest.new(
+  properties: null,
+  refresh_device_metadata: null,
+  deltas: null
+)
+```
+

data/docs/User.md

@@ -0,0 +1,24 @@
+# OneSignal::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **properties** | [**PropertiesObject**](PropertiesObject.md) |  | [optional] |
+| **identity** | **Hash<String, Object>** |  | [optional] |
+| **subscriptions** | [**Array<SubscriptionObject>**](SubscriptionObject.md) |  | [optional] |
+| **subscription_options** | [**UserSubscriptionOptions**](UserSubscriptionOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'onesignal'
+
+instance = OneSignal::User.new(
+  properties: null,
+  identity: null,
+  subscriptions: null,
+  subscription_options: null
+)
+```
+

data/docs/UserIdentityRequestBody.md

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

data/docs/UserIdentityResponse.md

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

data/docs/UserSubscriptionOptions.md

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