onesignal 0.2.0 → 1.0.1

data/lib/onesignal/models/notification_target.rb

@@ -0,0 +1,495 @@
+=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.0.1
+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 NotificationTarget
+    # 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\"] 
+    attr_accessor :included_segments
+
+    # 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\"] 
+    attr_accessor :excluded_segments
+
+    # relation = \">\" or \"<\" hours_ago = number of hours before or after the users last session. Example: \"1.1\" 
+    attr_accessor :last_session
+
+    # relation = \">\" or \"<\" hours_ago = number of hours before or after the users first session. Example: \"1.1\" 
+    attr_accessor :first_session
+
+    # relation = \">\", \"<\", \"=\" or \"!=\" value = number sessions. Example: \"1\" 
+    attr_accessor :session_count
+
+    # relation = \">\", \"<\", \"=\" or \"!=\" value = Time in seconds the user has been in your app. Example: \"3600\" 
+    attr_accessor :session_time
+
+    # relation = \">\", \"<\", or \"=\" value = Amount in USD a user has spent on IAP (In App Purchases). Example: \"0.99\" 
+    attr_accessor :amount_spent
+
+    # 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\" 
+    attr_accessor :bought_sku
+
+    # 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 
+    attr_accessor :tag
+
+    # relation = \"=\" or \"!=\" value = 2 character language code. Example: \"en\". For a list of all language codes see Language & Localization. 
+    attr_accessor :language
+
+    # relation = \">\", \"<\", \"=\" or \"!=\" value = app version. Example: \"1.0.0\" 
+    attr_accessor :app_version
+
+    # radius = in meters lat = latitude long = longitude 
+    attr_accessor :location
+
+    # 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 
+    attr_accessor :email
+
+    # relation = \"=\" value = 2-digit Country code Example: \"field\": \"country\", \"relation\": \"=\", \"value\", \"US\" 
+    attr_accessor :country
+
+    # 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 
+    attr_accessor :include_player_ids
+
+    # 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. 
+    attr_accessor :include_external_user_ids
+
+    # 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 
+    attr_accessor :include_email_tokens
+
+    # 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 
+    attr_accessor :include_phone_numbers
+
+    # 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 
+    attr_accessor :include_ios_tokens
+
+    # 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 
+    attr_accessor :include_wp_wns_uris
+
+    # 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 
+    attr_accessor :include_amazon_reg_ids
+
+    # 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 
+    attr_accessor :include_chrome_reg_ids
+
+    # 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 
+    attr_accessor :include_chrome_web_reg_ids
+
+    # 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 
+    attr_accessor :include_android_reg_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'included_segments' => :'included_segments',
+        :'excluded_segments' => :'excluded_segments',
+        :'last_session' => :'last_session',
+        :'first_session' => :'first_session',
+        :'session_count' => :'session_count',
+        :'session_time' => :'session_time',
+        :'amount_spent' => :'amount_spent',
+        :'bought_sku' => :'bought_sku',
+        :'tag' => :'tag',
+        :'language' => :'language',
+        :'app_version' => :'app_version',
+        :'location' => :'location',
+        :'email' => :'email',
+        :'country' => :'country',
+        :'include_player_ids' => :'include_player_ids',
+        :'include_external_user_ids' => :'include_external_user_ids',
+        :'include_email_tokens' => :'include_email_tokens',
+        :'include_phone_numbers' => :'include_phone_numbers',
+        :'include_ios_tokens' => :'include_ios_tokens',
+        :'include_wp_wns_uris' => :'include_wp_wns_uris',
+        :'include_amazon_reg_ids' => :'include_amazon_reg_ids',
+        :'include_chrome_reg_ids' => :'include_chrome_reg_ids',
+        :'include_chrome_web_reg_ids' => :'include_chrome_web_reg_ids',
+        :'include_android_reg_ids' => :'include_android_reg_ids'
+      }
+    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
+      {
+        :'included_segments' => :'Array<String>',
+        :'excluded_segments' => :'Array<String>',
+        :'last_session' => :'String',
+        :'first_session' => :'String',
+        :'session_count' => :'String',
+        :'session_time' => :'String',
+        :'amount_spent' => :'String',
+        :'bought_sku' => :'String',
+        :'tag' => :'String',
+        :'language' => :'String',
+        :'app_version' => :'String',
+        :'location' => :'String',
+        :'email' => :'String',
+        :'country' => :'String',
+        :'include_player_ids' => :'Array<String>',
+        :'include_external_user_ids' => :'Array<String>',
+        :'include_email_tokens' => :'Array<String>',
+        :'include_phone_numbers' => :'Array<String>',
+        :'include_ios_tokens' => :'Array<String>',
+        :'include_wp_wns_uris' => :'Array<String>',
+        :'include_amazon_reg_ids' => :'Array<String>',
+        :'include_chrome_reg_ids' => :'Array<String>',
+        :'include_chrome_web_reg_ids' => :'Array<String>',
+        :'include_android_reg_ids' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in anyOf (OpenAPI v3)
+    def self.openapi_any_of
+      [
+      :'FilterNotificationTarget',
+      :'PlayerNotificationTarget',
+      :'SegmentNotificationTarget'
+      ]
+    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::NotificationTarget` 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::NotificationTarget`. 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?(:'included_segments')
+        if (value = attributes[:'included_segments']).is_a?(Array)
+          self.included_segments = value
+        end
+      end
+
+      if attributes.key?(:'excluded_segments')
+        if (value = attributes[:'excluded_segments']).is_a?(Array)
+          self.excluded_segments = value
+        end
+      end
+
+      if attributes.key?(:'last_session')
+        self.last_session = attributes[:'last_session']
+      end
+
+      if attributes.key?(:'first_session')
+        self.first_session = attributes[:'first_session']
+      end
+
+      if attributes.key?(:'session_count')
+        self.session_count = attributes[:'session_count']
+      end
+
+      if attributes.key?(:'session_time')
+        self.session_time = attributes[:'session_time']
+      end
+
+      if attributes.key?(:'amount_spent')
+        self.amount_spent = attributes[:'amount_spent']
+      end
+
+      if attributes.key?(:'bought_sku')
+        self.bought_sku = attributes[:'bought_sku']
+      end
+
+      if attributes.key?(:'tag')
+        self.tag = attributes[:'tag']
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.key?(:'app_version')
+        self.app_version = attributes[:'app_version']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'include_player_ids')
+        if (value = attributes[:'include_player_ids']).is_a?(Array)
+          self.include_player_ids = value
+        end
+      end
+
+      if attributes.key?(:'include_external_user_ids')
+        if (value = attributes[:'include_external_user_ids']).is_a?(Array)
+          self.include_external_user_ids = value
+        end
+      end
+
+      if attributes.key?(:'include_email_tokens')
+        if (value = attributes[:'include_email_tokens']).is_a?(Array)
+          self.include_email_tokens = value
+        end
+      end
+
+      if attributes.key?(:'include_phone_numbers')
+        if (value = attributes[:'include_phone_numbers']).is_a?(Array)
+          self.include_phone_numbers = value
+        end
+      end
+
+      if attributes.key?(:'include_ios_tokens')
+        if (value = attributes[:'include_ios_tokens']).is_a?(Array)
+          self.include_ios_tokens = value
+        end
+      end
+
+      if attributes.key?(:'include_wp_wns_uris')
+        if (value = attributes[:'include_wp_wns_uris']).is_a?(Array)
+          self.include_wp_wns_uris = value
+        end
+      end
+
+      if attributes.key?(:'include_amazon_reg_ids')
+        if (value = attributes[:'include_amazon_reg_ids']).is_a?(Array)
+          self.include_amazon_reg_ids = value
+        end
+      end
+
+      if attributes.key?(:'include_chrome_reg_ids')
+        if (value = attributes[:'include_chrome_reg_ids']).is_a?(Array)
+          self.include_chrome_reg_ids = value
+        end
+      end
+
+      if attributes.key?(:'include_chrome_web_reg_ids')
+        if (value = attributes[:'include_chrome_web_reg_ids']).is_a?(Array)
+          self.include_chrome_web_reg_ids = value
+        end
+      end
+
+      if attributes.key?(:'include_android_reg_ids')
+        if (value = attributes[:'include_android_reg_ids']).is_a?(Array)
+          self.include_android_reg_ids = value
+        end
+      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?
+      _any_of_found = false
+      self.class.openapi_any_of.each do |_class|
+        _any_of = OneSignal.const_get(_class).build_from_hash(self.to_hash)
+        if _any_of.valid?
+          _any_of_found = true
+        end
+      end
+
+      if !_any_of_found
+        return false
+      end
+
+      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 &&
+          included_segments == o.included_segments &&
+          excluded_segments == o.excluded_segments &&
+          last_session == o.last_session &&
+          first_session == o.first_session &&
+          session_count == o.session_count &&
+          session_time == o.session_time &&
+          amount_spent == o.amount_spent &&
+          bought_sku == o.bought_sku &&
+          tag == o.tag &&
+          language == o.language &&
+          app_version == o.app_version &&
+          location == o.location &&
+          email == o.email &&
+          country == o.country &&
+          include_player_ids == o.include_player_ids &&
+          include_external_user_ids == o.include_external_user_ids &&
+          include_email_tokens == o.include_email_tokens &&
+          include_phone_numbers == o.include_phone_numbers &&
+          include_ios_tokens == o.include_ios_tokens &&
+          include_wp_wns_uris == o.include_wp_wns_uris &&
+          include_amazon_reg_ids == o.include_amazon_reg_ids &&
+          include_chrome_reg_ids == o.include_chrome_reg_ids &&
+          include_chrome_web_reg_ids == o.include_chrome_web_reg_ids &&
+          include_android_reg_ids == o.include_android_reg_ids
+    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
+      [included_segments, excluded_segments, last_session, first_session, session_count, session_time, amount_spent, bought_sku, tag, language, app_version, location, email, country, include_player_ids, include_external_user_ids, include_email_tokens, include_phone_numbers, include_ios_tokens, include_wp_wns_uris, include_amazon_reg_ids, include_chrome_reg_ids, include_chrome_web_reg_ids, include_android_reg_ids].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