onesignal 2.2.1 → 5.2.0.pre.beta1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onesignal
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 5.2.0.pre.beta1
 platform: ruby
 authors:
 - OneSignal
@@ -66,38 +66,26 @@ files:
 - docs/BasicNotification.md
 - docs/BasicNotificationAllOf.md
 - docs/BasicNotificationAllOfAndroidBackgroundLayout.md
-- docs/BeginLiveActivityRequest.md
 - docs/Button.md
-- docs/CancelNotificationSuccessResponse.md
 - docs/CreateNotificationSuccessResponse.md
-- docs/CreatePlayerSuccessResponse.md
 - docs/CreateSegmentConflictResponse.md
 - docs/CreateSegmentSuccessResponse.md
-- docs/CreateSubscriptionRequestBody.md
 - docs/CreateUserConflictResponse.md
 - docs/CreateUserConflictResponseErrorsInner.md
 - docs/CreateUserConflictResponseErrorsItemsMeta.md
 - docs/DefaultApi.md
-- docs/DeletePlayerNotFoundResponse.md
-- docs/DeletePlayerSuccessResponse.md
-- docs/DeleteSegmentNotFoundResponse.md
-- docs/DeleteSegmentSuccessResponse.md
 - docs/DeliveryData.md
 - docs/ExportEventsSuccessResponse.md
-- docs/ExportPlayersRequestBody.md
-- docs/ExportPlayersSuccessResponse.md
+- docs/ExportSubscriptionsRequestBody.md
+- docs/ExportSubscriptionsSuccessResponse.md
 - docs/Filter.md
-- docs/FilterExpressions.md
+- docs/FilterExpression.md
 - docs/GenericError.md
-- docs/GenericErrorErrorsInner.md
-- docs/GetNotificationRequestBody.md
-- docs/InlineResponse200.md
-- docs/InlineResponse2003.md
-- docs/InlineResponse201.md
-- docs/InlineResponse202.md
-- docs/InvalidIdentifierError.md
+- docs/GenericSuccessBoolResponse.md
+- docs/GetNotificationHistoryRequestBody.md
+- docs/GetSegmentsSuccessResponse.md
+- docs/LanguageStringMap.md
 - docs/Notification.md
-- docs/Notification200Errors.md
 - docs/NotificationAllOf.md
 - docs/NotificationHistorySuccessResponse.md
 - docs/NotificationSlice.md
@@ -110,30 +98,24 @@ files:
 - docs/PlatformDeliveryData.md
 - docs/PlatformDeliveryDataEmailAllOf.md
 - docs/PlatformDeliveryDataSmsAllOf.md
-- docs/Player.md
-- docs/PlayerNotificationTarget.md
-- docs/PlayerNotificationTargetIncludeAliases.md
-- docs/PlayerSlice.md
+- docs/PropertiesBody.md
 - docs/PropertiesDeltas.md
 - docs/PropertiesObject.md
 - docs/Purchase.md
-- docs/RateLimiterError.md
+- docs/RateLimitError.md
 - docs/Segment.md
+- docs/SegmentData.md
 - docs/SegmentNotificationTarget.md
-- docs/StringMap.md
-- docs/SubscriptionObject.md
+- docs/Subscription.md
+- docs/SubscriptionBody.md
+- docs/SubscriptionNotificationTarget.md
 - docs/TransferSubscriptionRequestBody.md
 - docs/UpdateLiveActivityRequest.md
 - docs/UpdateLiveActivitySuccessResponse.md
-- docs/UpdatePlayerSuccessResponse.md
-- docs/UpdatePlayerTagsRequestBody.md
-- docs/UpdatePlayerTagsSuccessResponse.md
-- docs/UpdateSubscriptionRequestBody.md
 - docs/UpdateUserRequest.md
 - docs/User.md
-- docs/UserIdentityRequestBody.md
-- docs/UserIdentityResponse.md
-- docs/UserSubscriptionOptions.md
+- docs/UserIdentityBody.md
+- docs/WebButton.md
 - lib/onesignal.rb
 - lib/onesignal/api/default_api.rb
 - lib/onesignal/api_client.rb
@@ -143,37 +125,25 @@ files:
 - lib/onesignal/models/basic_notification.rb
 - lib/onesignal/models/basic_notification_all_of.rb
 - lib/onesignal/models/basic_notification_all_of_android_background_layout.rb
-- lib/onesignal/models/begin_live_activity_request.rb
 - lib/onesignal/models/button.rb
-- lib/onesignal/models/cancel_notification_success_response.rb
 - lib/onesignal/models/create_notification_success_response.rb
-- lib/onesignal/models/create_player_success_response.rb
 - lib/onesignal/models/create_segment_conflict_response.rb
 - lib/onesignal/models/create_segment_success_response.rb
-- lib/onesignal/models/create_subscription_request_body.rb
 - lib/onesignal/models/create_user_conflict_response.rb
 - lib/onesignal/models/create_user_conflict_response_errors_inner.rb
 - lib/onesignal/models/create_user_conflict_response_errors_items_meta.rb
-- lib/onesignal/models/delete_player_not_found_response.rb
-- lib/onesignal/models/delete_player_success_response.rb
-- lib/onesignal/models/delete_segment_not_found_response.rb
-- lib/onesignal/models/delete_segment_success_response.rb
 - lib/onesignal/models/delivery_data.rb
 - lib/onesignal/models/export_events_success_response.rb
-- lib/onesignal/models/export_players_request_body.rb
-- lib/onesignal/models/export_players_success_response.rb
+- lib/onesignal/models/export_subscriptions_request_body.rb
+- lib/onesignal/models/export_subscriptions_success_response.rb
 - lib/onesignal/models/filter.rb
-- lib/onesignal/models/filter_expressions.rb
+- lib/onesignal/models/filter_expression.rb
 - lib/onesignal/models/generic_error.rb
-- lib/onesignal/models/generic_error_errors_inner.rb
-- lib/onesignal/models/get_notification_request_body.rb
-- lib/onesignal/models/inline_response200.rb
-- lib/onesignal/models/inline_response2003.rb
-- lib/onesignal/models/inline_response201.rb
-- lib/onesignal/models/inline_response202.rb
-- lib/onesignal/models/invalid_identifier_error.rb
+- lib/onesignal/models/generic_success_bool_response.rb
+- lib/onesignal/models/get_notification_history_request_body.rb
+- lib/onesignal/models/get_segments_success_response.rb
+- lib/onesignal/models/language_string_map.rb
 - lib/onesignal/models/notification.rb
-- lib/onesignal/models/notification200_errors.rb
 - lib/onesignal/models/notification_all_of.rb
 - lib/onesignal/models/notification_history_success_response.rb
 - lib/onesignal/models/notification_slice.rb
@@ -186,30 +156,24 @@ files:
 - lib/onesignal/models/platform_delivery_data.rb
 - lib/onesignal/models/platform_delivery_data_email_all_of.rb
 - lib/onesignal/models/platform_delivery_data_sms_all_of.rb
-- lib/onesignal/models/player.rb
-- lib/onesignal/models/player_notification_target.rb
-- lib/onesignal/models/player_notification_target_include_aliases.rb
-- lib/onesignal/models/player_slice.rb
+- lib/onesignal/models/properties_body.rb
 - lib/onesignal/models/properties_deltas.rb
 - lib/onesignal/models/properties_object.rb
 - lib/onesignal/models/purchase.rb
-- lib/onesignal/models/rate_limiter_error.rb
+- lib/onesignal/models/rate_limit_error.rb
 - lib/onesignal/models/segment.rb
+- lib/onesignal/models/segment_data.rb
 - lib/onesignal/models/segment_notification_target.rb
-- lib/onesignal/models/string_map.rb
-- lib/onesignal/models/subscription_object.rb
+- lib/onesignal/models/subscription.rb
+- lib/onesignal/models/subscription_body.rb
+- lib/onesignal/models/subscription_notification_target.rb
 - lib/onesignal/models/transfer_subscription_request_body.rb
 - lib/onesignal/models/update_live_activity_request.rb
 - lib/onesignal/models/update_live_activity_success_response.rb
-- lib/onesignal/models/update_player_success_response.rb
-- lib/onesignal/models/update_player_tags_request_body.rb
-- lib/onesignal/models/update_player_tags_success_response.rb
-- lib/onesignal/models/update_subscription_request_body.rb
 - lib/onesignal/models/update_user_request.rb
 - lib/onesignal/models/user.rb
-- lib/onesignal/models/user_identity_request_body.rb
-- lib/onesignal/models/user_identity_response.rb
-- lib/onesignal/models/user_subscription_options.rb
+- lib/onesignal/models/user_identity_body.rb
+- lib/onesignal/models/web_button.rb
 - lib/onesignal/version.rb
 - onesignal.gemspec
 - spec/api/default_api_spec.rb
@@ -219,36 +183,24 @@ files:
 - spec/models/basic_notification_all_of_android_background_layout_spec.rb
 - spec/models/basic_notification_all_of_spec.rb
 - spec/models/basic_notification_spec.rb
-- spec/models/begin_live_activity_request_spec.rb
 - spec/models/button_spec.rb
-- spec/models/cancel_notification_success_response_spec.rb
 - spec/models/create_notification_success_response_spec.rb
-- spec/models/create_player_success_response_spec.rb
 - spec/models/create_segment_conflict_response_spec.rb
 - spec/models/create_segment_success_response_spec.rb
-- spec/models/create_subscription_request_body_spec.rb
 - spec/models/create_user_conflict_response_errors_inner_spec.rb
 - spec/models/create_user_conflict_response_errors_items_meta_spec.rb
 - spec/models/create_user_conflict_response_spec.rb
-- spec/models/delete_player_not_found_response_spec.rb
-- spec/models/delete_player_success_response_spec.rb
-- spec/models/delete_segment_not_found_response_spec.rb
-- spec/models/delete_segment_success_response_spec.rb
 - spec/models/delivery_data_spec.rb
 - spec/models/export_events_success_response_spec.rb
-- spec/models/export_players_request_body_spec.rb
-- spec/models/export_players_success_response_spec.rb
-- spec/models/filter_expressions_spec.rb
+- spec/models/export_subscriptions_request_body_spec.rb
+- spec/models/export_subscriptions_success_response_spec.rb
+- spec/models/filter_expression_spec.rb
 - spec/models/filter_spec.rb
-- spec/models/generic_error_errors_inner_spec.rb
 - spec/models/generic_error_spec.rb
-- spec/models/get_notification_request_body_spec.rb
-- spec/models/inline_response2003_spec.rb
-- spec/models/inline_response200_spec.rb
-- spec/models/inline_response201_spec.rb
-- spec/models/inline_response202_spec.rb
-- spec/models/invalid_identifier_error_spec.rb
-- spec/models/notification200_errors_spec.rb
+- spec/models/generic_success_bool_response_spec.rb
+- spec/models/get_notification_history_request_body_spec.rb
+- spec/models/get_segments_success_response_spec.rb
+- spec/models/language_string_map_spec.rb
 - spec/models/notification_all_of_spec.rb
 - spec/models/notification_history_success_response_spec.rb
 - spec/models/notification_slice_spec.rb
@@ -262,30 +214,24 @@ files:
 - spec/models/platform_delivery_data_email_all_of_spec.rb
 - spec/models/platform_delivery_data_sms_all_of_spec.rb
 - spec/models/platform_delivery_data_spec.rb
-- spec/models/player_notification_target_include_aliases_spec.rb
-- spec/models/player_notification_target_spec.rb
-- spec/models/player_slice_spec.rb
-- spec/models/player_spec.rb
+- spec/models/properties_body_spec.rb
 - spec/models/properties_deltas_spec.rb
 - spec/models/properties_object_spec.rb
 - spec/models/purchase_spec.rb
-- spec/models/rate_limiter_error_spec.rb
+- spec/models/rate_limit_error_spec.rb
+- spec/models/segment_data_spec.rb
 - spec/models/segment_notification_target_spec.rb
 - spec/models/segment_spec.rb
-- spec/models/string_map_spec.rb
-- spec/models/subscription_object_spec.rb
+- spec/models/subscription_body_spec.rb
+- spec/models/subscription_notification_target_spec.rb
+- spec/models/subscription_spec.rb
 - spec/models/transfer_subscription_request_body_spec.rb
 - spec/models/update_live_activity_request_spec.rb
 - spec/models/update_live_activity_success_response_spec.rb
-- spec/models/update_player_success_response_spec.rb
-- spec/models/update_player_tags_request_body_spec.rb
-- spec/models/update_player_tags_success_response_spec.rb
-- spec/models/update_subscription_request_body_spec.rb
 - spec/models/update_user_request_spec.rb
-- spec/models/user_identity_request_body_spec.rb
-- spec/models/user_identity_response_spec.rb
+- spec/models/user_identity_body_spec.rb
 - spec/models/user_spec.rb
-- spec/models/user_subscription_options_spec.rb
+- spec/models/web_button_spec.rb
 - spec/spec_helper.rb
 homepage: https://onesignal.com/
 licenses:
@@ -316,36 +262,24 @@ test_files:
 - spec/models/basic_notification_all_of_android_background_layout_spec.rb
 - spec/models/basic_notification_all_of_spec.rb
 - spec/models/basic_notification_spec.rb
-- spec/models/begin_live_activity_request_spec.rb
 - spec/models/button_spec.rb
-- spec/models/cancel_notification_success_response_spec.rb
 - spec/models/create_notification_success_response_spec.rb
-- spec/models/create_player_success_response_spec.rb
 - spec/models/create_segment_conflict_response_spec.rb
 - spec/models/create_segment_success_response_spec.rb
-- spec/models/create_subscription_request_body_spec.rb
 - spec/models/create_user_conflict_response_errors_inner_spec.rb
 - spec/models/create_user_conflict_response_errors_items_meta_spec.rb
 - spec/models/create_user_conflict_response_spec.rb
-- spec/models/delete_player_not_found_response_spec.rb
-- spec/models/delete_player_success_response_spec.rb
-- spec/models/delete_segment_not_found_response_spec.rb
-- spec/models/delete_segment_success_response_spec.rb
 - spec/models/delivery_data_spec.rb
 - spec/models/export_events_success_response_spec.rb
-- spec/models/export_players_request_body_spec.rb
-- spec/models/export_players_success_response_spec.rb
-- spec/models/filter_expressions_spec.rb
+- spec/models/export_subscriptions_request_body_spec.rb
+- spec/models/export_subscriptions_success_response_spec.rb
+- spec/models/filter_expression_spec.rb
 - spec/models/filter_spec.rb
-- spec/models/generic_error_errors_inner_spec.rb
 - spec/models/generic_error_spec.rb
-- spec/models/get_notification_request_body_spec.rb
-- spec/models/inline_response2003_spec.rb
-- spec/models/inline_response200_spec.rb
-- spec/models/inline_response201_spec.rb
-- spec/models/inline_response202_spec.rb
-- spec/models/invalid_identifier_error_spec.rb
-- spec/models/notification200_errors_spec.rb
+- spec/models/generic_success_bool_response_spec.rb
+- spec/models/get_notification_history_request_body_spec.rb
+- spec/models/get_segments_success_response_spec.rb
+- spec/models/language_string_map_spec.rb
 - spec/models/notification_all_of_spec.rb
 - spec/models/notification_history_success_response_spec.rb
 - spec/models/notification_slice_spec.rb
@@ -359,28 +293,22 @@ test_files:
 - spec/models/platform_delivery_data_email_all_of_spec.rb
 - spec/models/platform_delivery_data_sms_all_of_spec.rb
 - spec/models/platform_delivery_data_spec.rb
-- spec/models/player_notification_target_include_aliases_spec.rb
-- spec/models/player_notification_target_spec.rb
-- spec/models/player_slice_spec.rb
-- spec/models/player_spec.rb
+- spec/models/properties_body_spec.rb
 - spec/models/properties_deltas_spec.rb
 - spec/models/properties_object_spec.rb
 - spec/models/purchase_spec.rb
-- spec/models/rate_limiter_error_spec.rb
+- spec/models/rate_limit_error_spec.rb
+- spec/models/segment_data_spec.rb
 - spec/models/segment_notification_target_spec.rb
 - spec/models/segment_spec.rb
-- spec/models/string_map_spec.rb
-- spec/models/subscription_object_spec.rb
+- spec/models/subscription_body_spec.rb
+- spec/models/subscription_notification_target_spec.rb
+- spec/models/subscription_spec.rb
 - spec/models/transfer_subscription_request_body_spec.rb
 - spec/models/update_live_activity_request_spec.rb
 - spec/models/update_live_activity_success_response_spec.rb
-- spec/models/update_player_success_response_spec.rb
-- spec/models/update_player_tags_request_body_spec.rb
-- spec/models/update_player_tags_success_response_spec.rb
-- spec/models/update_subscription_request_body_spec.rb
 - spec/models/update_user_request_spec.rb
-- spec/models/user_identity_request_body_spec.rb
-- spec/models/user_identity_response_spec.rb
+- spec/models/user_identity_body_spec.rb
 - spec/models/user_spec.rb
-- spec/models/user_subscription_options_spec.rb
+- spec/models/web_button_spec.rb
 - spec/spec_helper.rb

data/docs/BeginLiveActivityRequest.md

@@ -1,20 +0,0 @@
-# OneSignal::BeginLiveActivityRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **push_token** | **String** |  |  |
-| **subscription_id** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'onesignal'
-
-instance = OneSignal::BeginLiveActivityRequest.new(
-  push_token: null,
-  subscription_id: null
-)
-```
-

data/docs/CancelNotificationSuccessResponse.md

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

data/docs/CreatePlayerSuccessResponse.md

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

data/docs/CreateSubscriptionRequestBody.md

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

data/docs/DeletePlayerNotFoundResponse.md

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

data/docs/DeleteSegmentNotFoundResponse.md

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

data/docs/DeleteSegmentSuccessResponse.md

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

data/docs/FilterExpressions.md

@@ -1,26 +0,0 @@
-# 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/GenericErrorErrorsInner.md

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

data/docs/InlineResponse2003.md

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

data/docs/InlineResponse201.md

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

data/docs/InvalidIdentifierError.md

@@ -1,20 +0,0 @@
-# OneSignal::InvalidIdentifierError
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **invalid_external_user_ids** | **Array<String>** | Returned if using include_external_user_ids | [optional] |
-| **invalid_player_ids** | **Array<String>** | Returned if using include_player_ids and some were valid and others were not. | [optional] |
-
-## Example
-
-```ruby
-require 'onesignal'
-
-instance = OneSignal::InvalidIdentifierError.new(
-  invalid_external_user_ids: null,
-  invalid_player_ids: null
-)
-```
-

data/docs/Player.md

@@ -1,70 +0,0 @@
-# OneSignal::Player
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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** |  | [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] |
-| **email_auth_hash** | **String** | Email - Only required if you have enabled Identity Verification and device_type is email (11). | [optional] |
-| **identifier** | **String** | Recommended: For Push Notifications, this is the Push Token Identifier from Google or Apple. For Apple Push identifiers, you must strip all non alphanumeric characters. Examples: iOS: 7abcd558f29d0b1f048083e2834ad8ea4b3d87d8ad9c088b33c132706ff445f0 Android: APA91bHbYHk7aq-Uam_2pyJ2qbZvqllyyh2wjfPRaw5gLEX2SUlQBRvOc6sck1sa7H7nGeLNlDco8lXj83HWWwzV... For Email Addresses, set the full email address email@email.com and make sure to set device_type to 11.  | [optional] |
-| **language** | **String** | Language code. Typically lower case two letters, except for Chinese where it must be one of zh-Hans or zh-Hant. Example: en  | [optional] |
-| **timezone** | **Integer** | Number of seconds away from UTC. Example: -28800  | [optional] |
-| **game_version** | **String** | Version of your app. Example: 1.1  | [optional] |
-| **device_model** | **String** | Device make and model. Example: iPhone5,1  | [optional] |
-| **device_os** | **String** | Device operating system version. Example: 7.0.4  | [optional] |
-| **ad_id** | **String** | The ad id for the device's platform: Android = Advertising Id iOS = identifierForVendor WP8.0 = DeviceUniqueId WP8.1 = AdvertisingId  | [optional] |
-| **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** | **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] |
-| **last_active** | **Integer** | Unixtime when the player was last active | [optional] |
-| **notification_types** | **Integer** | 1 = subscribed -2 = unsubscribed iOS - These values are set each time the user opens the app from the SDK. Use the SDK function set Subscription instead. Android - You may set this but you can no longer use the SDK method setSubscription later in your app as it will create synchronization issues.  | [optional] |
-| **test_type** | **Integer** | This is used in deciding whether to use your iOS Sandbox or Production push certificate when sending a push when both have been uploaded. Set to the iOS provisioning profile that was used to build your app. 1 = Development 2 = Ad-Hoc Omit this field for App Store builds.  | [optional] |
-| **long** | **Float** | Longitude of the device, used for geotagging to segment on. | [optional] |
-| **lat** | **Float** | Latitude of the device, used for geotagging to segment on. | [optional] |
-| **country** | **String** | Country code in the ISO 3166-1 Alpha 2 format | [optional] |
-
-## Example
-
-```ruby
-require 'onesignal'
-
-instance = OneSignal::Player.new(
-  id: null,
-  invalid_identifier: null,
-  app_id: null,
-  device_type: null,
-  external_user_id: null,
-  external_user_id_auth_hash: null,
-  email_auth_hash: null,
-  identifier: null,
-  language: null,
-  timezone: null,
-  game_version: null,
-  device_model: null,
-  device_os: null,
-  ad_id: null,
-  sdk: null,
-  session_count: null,
-  tags: null,
-  amount_spent: null,
-  created_at: null,
-  playtime: null,
-  badge_count: null,
-  last_active: null,
-  notification_types: null,
-  test_type: null,
-  long: null,
-  lat: null,
-  country: null
-)
-```
-