onesignal 5.11.2 → 5.12.0

data/lib/onesignal/models/journey_node.rb

@@ -0,0 +1,480 @@
+=begin
+#OneSignal
+
+#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
+
+Contact: devrel@onesignal.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module OneSignal
+  # A journey node. The kind field selects which other fields apply. Branching nodes (split_range, yes_no, wait_until) nest their sub-graphs inline via branches[].nodes.
+  class JourneyNode
+    # Server-assigned node UUID. Returned on reads. Required on update to keep an existing node. Rejected on create with a 400 validation error.
+    attr_accessor :id
+
+    # Node kind. Selects which other fields apply.
+    attr_accessor :kind
+
+    # Optional client-assigned identifier, unique within the journey. Use it to reference this node from elsewhere in the same request. Persisted and returned on reads.
+    attr_accessor :client_node_id
+
+    # Optional free-text label, up to 255 characters. Stored and returned as-is with no effect on journey behavior.
+    attr_accessor :annotation
+
+    # wait nodes: seconds to hold the user. Minimum 60, maximum 31556952 (1 year).
+    attr_accessor :duration_seconds
+
+    # time_window nodes: schedule_in_timezone uses the configured windows; last_active_time holds relative to the user's last active time.
+    attr_accessor :relative_to
+
+    # time_window nodes: one or more time windows. A window with no day_of_week applies to every day. Required when relative_to is schedule_in_timezone; omit when it is last_active_time.
+    attr_accessor :windows
+
+    # time_window nodes: IANA timezone identifier used when the user's timezone is unavailable.
+    attr_accessor :time_zone
+
+    # time_window nodes: when true, uses the user's timezone if available.
+    attr_accessor :use_user_time_zone
+
+    # send_push, send_email, and send_sms nodes: UUID of the template to send.
+    attr_accessor :template_id
+
+    # send_iam nodes: UUID of the in-app message to send.
+    attr_accessor :iam_id
+
+    # send_iam nodes: optional time-to-live for the in-app message, in seconds.
+    attr_accessor :user_ttl_seconds
+
+    # send_webhook nodes: UUID of the webhook to send.
+    attr_accessor :webhook_id
+
+    # tag nodes: tag key-value pairs to assign. An empty string value removes the tag. Keys are limited to 255 characters and values to 1024.
+    attr_accessor :assignments
+
+    # split_range nodes: when true, assigns each user to a branch at random on entry. Defaults to false.
+    attr_accessor :randomize_on_entry
+
+    # Branching nodes: nested branches. split_range requires 2-20 weighted branches that sum to 100. yes_no requires exactly 2 branches. wait_until requires 1-10 condition branches.
+    attr_accessor :branches
+
+    attr_accessor :expiration
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'kind' => :'kind',
+        :'client_node_id' => :'client_node_id',
+        :'annotation' => :'annotation',
+        :'duration_seconds' => :'duration_seconds',
+        :'relative_to' => :'relative_to',
+        :'windows' => :'windows',
+        :'time_zone' => :'time_zone',
+        :'use_user_time_zone' => :'use_user_time_zone',
+        :'template_id' => :'template_id',
+        :'iam_id' => :'iam_id',
+        :'user_ttl_seconds' => :'user_ttl_seconds',
+        :'webhook_id' => :'webhook_id',
+        :'assignments' => :'assignments',
+        :'randomize_on_entry' => :'randomize_on_entry',
+        :'branches' => :'branches',
+        :'expiration' => :'expiration'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'kind' => :'String',
+        :'client_node_id' => :'String',
+        :'annotation' => :'String',
+        :'duration_seconds' => :'Integer',
+        :'relative_to' => :'String',
+        :'windows' => :'Array<JourneyTimeWindow>',
+        :'time_zone' => :'String',
+        :'use_user_time_zone' => :'Boolean',
+        :'template_id' => :'String',
+        :'iam_id' => :'String',
+        :'user_ttl_seconds' => :'Integer',
+        :'webhook_id' => :'String',
+        :'assignments' => :'Hash<String, String>',
+        :'randomize_on_entry' => :'Boolean',
+        :'branches' => :'Array<JourneyBranch>',
+        :'expiration' => :'JourneyWaitUntilExpiration'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'duration_seconds',
+        :'use_user_time_zone',
+        :'user_ttl_seconds',
+        :'randomize_on_entry',
+        :'expiration'
+      ])
+    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::JourneyNode` 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::JourneyNode`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      if attributes.key?(:'client_node_id')
+        self.client_node_id = attributes[:'client_node_id']
+      end
+
+      if attributes.key?(:'annotation')
+        self.annotation = attributes[:'annotation']
+      end
+
+      if attributes.key?(:'duration_seconds')
+        self.duration_seconds = attributes[:'duration_seconds']
+      end
+
+      if attributes.key?(:'relative_to')
+        self.relative_to = attributes[:'relative_to']
+      end
+
+      if attributes.key?(:'windows')
+        if (value = attributes[:'windows']).is_a?(Array)
+          self.windows = value
+        end
+      end
+
+      if attributes.key?(:'time_zone')
+        self.time_zone = attributes[:'time_zone']
+      end
+
+      if attributes.key?(:'use_user_time_zone')
+        self.use_user_time_zone = attributes[:'use_user_time_zone']
+      end
+
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      end
+
+      if attributes.key?(:'iam_id')
+        self.iam_id = attributes[:'iam_id']
+      end
+
+      if attributes.key?(:'user_ttl_seconds')
+        self.user_ttl_seconds = attributes[:'user_ttl_seconds']
+      end
+
+      if attributes.key?(:'webhook_id')
+        self.webhook_id = attributes[:'webhook_id']
+      end
+
+      if attributes.key?(:'assignments')
+        if (value = attributes[:'assignments']).is_a?(Hash)
+          self.assignments = value
+        end
+      end
+
+      if attributes.key?(:'randomize_on_entry')
+        self.randomize_on_entry = attributes[:'randomize_on_entry']
+      end
+
+      if attributes.key?(:'branches')
+        if (value = attributes[:'branches']).is_a?(Array)
+          self.branches = value
+        end
+      end
+
+      if attributes.key?(:'expiration')
+        self.expiration = attributes[:'expiration']
+      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
+      if @kind.nil?
+        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      end
+
+      if !@duration_seconds.nil? && @duration_seconds > 31556952
+        invalid_properties.push('invalid value for "duration_seconds", must be smaller than or equal to 31556952.')
+      end
+
+      if !@duration_seconds.nil? && @duration_seconds < 60
+        invalid_properties.push('invalid value for "duration_seconds", must be greater than or equal to 60.')
+      end
+
+      if !@user_ttl_seconds.nil? && @user_ttl_seconds < 1
+        invalid_properties.push('invalid value for "user_ttl_seconds", must be greater than or equal to 1.')
+      end
+
+      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?
+      return false if @kind.nil?
+      kind_validator = EnumAttributeValidator.new('String', ["wait", "time_window", "send_push", "send_email", "send_sms", "send_iam", "send_webhook", "tag", "split_range", "yes_no", "wait_until"])
+      return false unless kind_validator.valid?(@kind)
+      return false if !@duration_seconds.nil? && @duration_seconds > 31556952
+      return false if !@duration_seconds.nil? && @duration_seconds < 60
+      relative_to_validator = EnumAttributeValidator.new('String', ["schedule_in_timezone", "last_active_time"])
+      return false unless relative_to_validator.valid?(@relative_to)
+      return false if !@user_ttl_seconds.nil? && @user_ttl_seconds < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] kind Object to be assigned
+    def kind=(kind)
+      validator = EnumAttributeValidator.new('String', ["wait", "time_window", "send_push", "send_email", "send_sms", "send_iam", "send_webhook", "tag", "split_range", "yes_no", "wait_until"])
+      unless validator.valid?(kind)
+        fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
+      end
+      @kind = kind
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] duration_seconds Value to be assigned
+    def duration_seconds=(duration_seconds)
+      if !duration_seconds.nil? && duration_seconds > 31556952
+        fail ArgumentError, 'invalid value for "duration_seconds", must be smaller than or equal to 31556952.'
+      end
+
+      if !duration_seconds.nil? && duration_seconds < 60
+        fail ArgumentError, 'invalid value for "duration_seconds", must be greater than or equal to 60.'
+      end
+
+      @duration_seconds = duration_seconds
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] relative_to Object to be assigned
+    def relative_to=(relative_to)
+      validator = EnumAttributeValidator.new('String', ["schedule_in_timezone", "last_active_time"])
+      unless validator.valid?(relative_to)
+        fail ArgumentError, "invalid value for \"relative_to\", must be one of #{validator.allowable_values}."
+      end
+      @relative_to = relative_to
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] user_ttl_seconds Value to be assigned
+    def user_ttl_seconds=(user_ttl_seconds)
+      if !user_ttl_seconds.nil? && user_ttl_seconds < 1
+        fail ArgumentError, 'invalid value for "user_ttl_seconds", must be greater than or equal to 1.'
+      end
+
+      @user_ttl_seconds = user_ttl_seconds
+    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 &&
+          id == o.id &&
+          kind == o.kind &&
+          client_node_id == o.client_node_id &&
+          annotation == o.annotation &&
+          duration_seconds == o.duration_seconds &&
+          relative_to == o.relative_to &&
+          windows == o.windows &&
+          time_zone == o.time_zone &&
+          use_user_time_zone == o.use_user_time_zone &&
+          template_id == o.template_id &&
+          iam_id == o.iam_id &&
+          user_ttl_seconds == o.user_ttl_seconds &&
+          webhook_id == o.webhook_id &&
+          assignments == o.assignments &&
+          randomize_on_entry == o.randomize_on_entry &&
+          branches == o.branches &&
+          expiration == o.expiration
+    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
+      [id, kind, client_node_id, annotation, duration_seconds, relative_to, windows, time_zone, use_user_time_zone, template_id, iam_id, user_ttl_seconds, webhook_id, assignments, randomize_on_entry, branches, expiration].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