onesignal 2.2.0 → 5.1.0.pre.beta1

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
-)
-```
-

data/docs/PlayerNotificationTarget.md

@@ -1,40 +0,0 @@
-# OneSignal::PlayerNotificationTarget
-
-## Properties
-
-| 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_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] |
-| **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] |
-| **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] |
-| **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
-
-```ruby
-require 'onesignal'
-
-instance = OneSignal::PlayerNotificationTarget.new(
-  include_player_ids: null,
-  include_external_user_ids: null,
-  include_email_tokens: null,
-  include_phone_numbers: null,
-  include_ios_tokens: null,
-  include_wp_wns_uris: null,
-  include_amazon_reg_ids: null,
-  include_chrome_reg_ids: null,
-  include_chrome_web_reg_ids: null,
-  include_android_reg_ids: null,
-  include_aliases: null,
-  target_channel: null
-)
-```
-

data/docs/PlayerNotificationTargetIncludeAliases.md

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

@@ -1,24 +0,0 @@
-# OneSignal::PlayerSlice
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **total_count** | **Integer** |  | [optional] |
-| **offset** | **Integer** |  | [optional] |
-| **limit** | **Integer** |  | [optional] |
-| **players** | [**Array<Player>**](Player.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'onesignal'
-
-instance = OneSignal::PlayerSlice.new(
-  total_count: null,
-  offset: null,
-  limit: null,
-  players: null
-)
-```
-

data/docs/UpdatePlayerSuccessResponse.md

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

data/docs/UpdatePlayerTagsRequestBody.md

@@ -1,18 +0,0 @@
-# OneSignal::UpdatePlayerTagsRequestBody
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **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] |
-
-## Example
-
-```ruby
-require 'onesignal'
-
-instance = OneSignal::UpdatePlayerTagsRequestBody.new(
-  tags: null
-)
-```
-

data/docs/UpdatePlayerTagsSuccessResponse.md

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

data/docs/UpdateSubscriptionRequestBody.md

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

data/docs/UserIdentityRequestBody.md

@@ -1,18 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# 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

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

data/lib/onesignal/models/cancel_notification_success_response.rb

@@ -1,219 +0,0 @@
-=begin
-#OneSignal
-
-#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
-
-The version of the OpenAPI document: 1.4.0
-Contact: devrel@onesignal.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
-
-=end
-
-require 'date'
-require 'time'
-
-module OneSignal
-  class CancelNotificationSuccessResponse
-    attr_accessor :success
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'success' => :'success'
-      }
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'success' => :'Boolean'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `OneSignal::CancelNotificationSuccessResponse` initialize method"
-      end
-
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          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
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'success')
-        self.success = attributes[:'success']
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          success == o.success
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [success].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = OneSignal.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
-  end
-
-end