hubspot-api-client 17.1.1 → 17.2.0

data/lib/hubspot/codegen/crm/lists/models/public_email_event_filter.rb

@@ -0,0 +1,350 @@
+=begin
+#Lists
+
+#CRUD operations to manage lists and list memberships
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Crm
+    module Lists
+      class PublicEmailEventFilter
+        attr_accessor :filter_type
+
+        attr_accessor :level
+
+        attr_accessor :email_id
+
+        attr_accessor :app_id
+
+        attr_accessor :operator
+
+        attr_accessor :click_url
+
+        attr_accessor :pruning_refine_by
+
+        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
+          {
+            :'filter_type' => :'filterType',
+            :'level' => :'level',
+            :'email_id' => :'emailId',
+            :'app_id' => :'appId',
+            :'operator' => :'operator',
+            :'click_url' => :'clickUrl',
+            :'pruning_refine_by' => :'pruningRefineBy'
+          }
+        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
+          {
+            :'filter_type' => :'String',
+            :'level' => :'String',
+            :'email_id' => :'Integer',
+            :'app_id' => :'Integer',
+            :'operator' => :'String',
+            :'click_url' => :'String',
+            :'pruning_refine_by' => :'PublicEventAnalyticsFilterCoalescingRefineBy'
+          }
+        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 `Hubspot::Crm::Lists::PublicEmailEventFilter` 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 `Hubspot::Crm::Lists::PublicEmailEventFilter`. 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?(:'filter_type')
+            self.filter_type = attributes[:'filter_type']
+          else
+            self.filter_type = 'EMAIL_EVENT'
+          end
+
+          if attributes.key?(:'level')
+            self.level = attributes[:'level']
+          end
+
+          if attributes.key?(:'email_id')
+            self.email_id = attributes[:'email_id']
+          end
+
+          if attributes.key?(:'app_id')
+            self.app_id = attributes[:'app_id']
+          end
+
+          if attributes.key?(:'operator')
+            self.operator = attributes[:'operator']
+          end
+
+          if attributes.key?(:'click_url')
+            self.click_url = attributes[:'click_url']
+          end
+
+          if attributes.key?(:'pruning_refine_by')
+            self.pruning_refine_by = attributes[:'pruning_refine_by']
+          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 @filter_type.nil?
+            invalid_properties.push('invalid value for "filter_type", filter_type cannot be nil.')
+          end
+
+          if @level.nil?
+            invalid_properties.push('invalid value for "level", level cannot be nil.')
+          end
+
+          if @email_id.nil?
+            invalid_properties.push('invalid value for "email_id", email_id cannot be nil.')
+          end
+
+          if @app_id.nil?
+            invalid_properties.push('invalid value for "app_id", app_id cannot be nil.')
+          end
+
+          if @operator.nil?
+            invalid_properties.push('invalid value for "operator", operator cannot be nil.')
+          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 @filter_type.nil?
+          filter_type_validator = EnumAttributeValidator.new('String', ["EMAIL_EVENT"])
+          return false unless filter_type_validator.valid?(@filter_type)
+          return false if @level.nil?
+          return false if @email_id.nil?
+          return false if @app_id.nil?
+          return false if @operator.nil?
+          operator_validator = EnumAttributeValidator.new('String', ["LINK_CLICKED", "MARKED_SPAM", "OPENED", "OPENED_BUT_LINK_NOT_CLICKED", "OPENED_BUT_NOT_REPLIED", "REPLIED", "UNSUBSCRIBED", "BOUNCED", "RECEIVED", "RECEIVED_BUT_NOT_OPENED", "SENT", "SENT_BUT_LINK_NOT_CLICKED", "SENT_BUT_NOT_RECEIVED"])
+          return false unless operator_validator.valid?(@operator)
+          true
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] filter_type Object to be assigned
+        def filter_type=(filter_type)
+          validator = EnumAttributeValidator.new('String', ["EMAIL_EVENT"])
+          unless validator.valid?(filter_type)
+            fail ArgumentError, "invalid value for \"filter_type\", must be one of #{validator.allowable_values}."
+          end
+          @filter_type = filter_type
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] operator Object to be assigned
+        def operator=(operator)
+          validator = EnumAttributeValidator.new('String', ["LINK_CLICKED", "MARKED_SPAM", "OPENED", "OPENED_BUT_LINK_NOT_CLICKED", "OPENED_BUT_NOT_REPLIED", "REPLIED", "UNSUBSCRIBED", "BOUNCED", "RECEIVED", "RECEIVED_BUT_NOT_OPENED", "SENT", "SENT_BUT_LINK_NOT_CLICKED", "SENT_BUT_NOT_RECEIVED"])
+          unless validator.valid?(operator)
+            fail ArgumentError, "invalid value for \"operator\", must be one of #{validator.allowable_values}."
+          end
+          @operator = operator
+        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 &&
+              filter_type == o.filter_type &&
+              level == o.level &&
+              email_id == o.email_id &&
+              app_id == o.app_id &&
+              operator == o.operator &&
+              click_url == o.click_url &&
+              pruning_refine_by == o.pruning_refine_by
+        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
+          [filter_type, level, email_id, app_id, operator, click_url, pruning_refine_by].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 = Hubspot::Crm::Lists.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
+  end
+end

data/lib/hubspot/codegen/crm/lists/models/public_email_subscription_filter.rb

@@ -0,0 +1,305 @@
+=begin
+#Lists
+
+#CRUD operations to manage lists and list memberships
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Hubspot
+  module Crm
+    module Lists
+      class PublicEmailSubscriptionFilter
+        attr_accessor :filter_type
+
+        attr_accessor :subscription_ids
+
+        attr_accessor :accepted_statuses
+
+        attr_accessor :subscription_type
+
+        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
+          {
+            :'filter_type' => :'filterType',
+            :'subscription_ids' => :'subscriptionIds',
+            :'accepted_statuses' => :'acceptedStatuses',
+            :'subscription_type' => :'subscriptionType'
+          }
+        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
+          {
+            :'filter_type' => :'String',
+            :'subscription_ids' => :'Array<Integer>',
+            :'accepted_statuses' => :'Array<String>',
+            :'subscription_type' => :'String'
+          }
+        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 `Hubspot::Crm::Lists::PublicEmailSubscriptionFilter` 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 `Hubspot::Crm::Lists::PublicEmailSubscriptionFilter`. 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?(:'filter_type')
+            self.filter_type = attributes[:'filter_type']
+          else
+            self.filter_type = 'EMAIL_SUBSCRIPTION'
+          end
+
+          if attributes.key?(:'subscription_ids')
+            if (value = attributes[:'subscription_ids']).is_a?(Array)
+              self.subscription_ids = value
+            end
+          end
+
+          if attributes.key?(:'accepted_statuses')
+            if (value = attributes[:'accepted_statuses']).is_a?(Array)
+              self.accepted_statuses = value
+            end
+          end
+
+          if attributes.key?(:'subscription_type')
+            self.subscription_type = attributes[:'subscription_type']
+          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 @filter_type.nil?
+            invalid_properties.push('invalid value for "filter_type", filter_type cannot be nil.')
+          end
+
+          if @subscription_ids.nil?
+            invalid_properties.push('invalid value for "subscription_ids", subscription_ids cannot be nil.')
+          end
+
+          if @accepted_statuses.nil?
+            invalid_properties.push('invalid value for "accepted_statuses", accepted_statuses cannot be nil.')
+          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 @filter_type.nil?
+          filter_type_validator = EnumAttributeValidator.new('String', ["EMAIL_SUBSCRIPTION"])
+          return false unless filter_type_validator.valid?(@filter_type)
+          return false if @subscription_ids.nil?
+          return false if @accepted_statuses.nil?
+          true
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] filter_type Object to be assigned
+        def filter_type=(filter_type)
+          validator = EnumAttributeValidator.new('String', ["EMAIL_SUBSCRIPTION"])
+          unless validator.valid?(filter_type)
+            fail ArgumentError, "invalid value for \"filter_type\", must be one of #{validator.allowable_values}."
+          end
+          @filter_type = filter_type
+        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 &&
+              filter_type == o.filter_type &&
+              subscription_ids == o.subscription_ids &&
+              accepted_statuses == o.accepted_statuses &&
+              subscription_type == o.subscription_type
+        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
+          [filter_type, subscription_ids, accepted_statuses, subscription_type].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 = Hubspot::Crm::Lists.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
+  end
+end