hubspot-api-client 17.1.0 → 17.2.0

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

@@ -0,0 +1,333 @@
+=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 PublicCommunicationSubscriptionFilter
+        attr_accessor :filter_type
+
+        attr_accessor :subscription_ids
+
+        attr_accessor :channel
+
+        attr_accessor :accepted_opt_states
+
+        attr_accessor :business_unit_id
+
+        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',
+            :'channel' => :'channel',
+            :'accepted_opt_states' => :'acceptedOptStates',
+            :'business_unit_id' => :'businessUnitId',
+            :'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>',
+            :'channel' => :'String',
+            :'accepted_opt_states' => :'Array<String>',
+            :'business_unit_id' => :'Integer',
+            :'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::PublicCommunicationSubscriptionFilter` 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::PublicCommunicationSubscriptionFilter`. 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 = 'COMMUNICATION_SUBSCRIPTION'
+          end
+
+          if attributes.key?(:'subscription_ids')
+            if (value = attributes[:'subscription_ids']).is_a?(Array)
+              self.subscription_ids = value
+            end
+          end
+
+          if attributes.key?(:'channel')
+            self.channel = attributes[:'channel']
+          end
+
+          if attributes.key?(:'accepted_opt_states')
+            if (value = attributes[:'accepted_opt_states']).is_a?(Array)
+              self.accepted_opt_states = value
+            end
+          end
+
+          if attributes.key?(:'business_unit_id')
+            self.business_unit_id = attributes[:'business_unit_id']
+          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 @channel.nil?
+            invalid_properties.push('invalid value for "channel", channel cannot be nil.')
+          end
+
+          if @accepted_opt_states.nil?
+            invalid_properties.push('invalid value for "accepted_opt_states", accepted_opt_states cannot be nil.')
+          end
+
+          if @subscription_type.nil?
+            invalid_properties.push('invalid value for "subscription_type", subscription_type 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', ["COMMUNICATION_SUBSCRIPTION"])
+          return false unless filter_type_validator.valid?(@filter_type)
+          return false if @subscription_ids.nil?
+          return false if @channel.nil?
+          return false if @accepted_opt_states.nil?
+          return false if @subscription_type.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', ["COMMUNICATION_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 &&
+              channel == o.channel &&
+              accepted_opt_states == o.accepted_opt_states &&
+              business_unit_id == o.business_unit_id &&
+              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, channel, accepted_opt_states, business_unit_id, 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

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

@@ -0,0 +1,315 @@
+=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 PublicComparativeDatePropertyOperation
+        attr_accessor :operation_type
+
+        attr_accessor :operator
+
+        attr_accessor :include_objects_with_no_value_set
+
+        attr_accessor :comparison_property_name
+
+        attr_accessor :default_comparison_value
+
+        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
+          {
+            :'operation_type' => :'operationType',
+            :'operator' => :'operator',
+            :'include_objects_with_no_value_set' => :'includeObjectsWithNoValueSet',
+            :'comparison_property_name' => :'comparisonPropertyName',
+            :'default_comparison_value' => :'defaultComparisonValue'
+          }
+        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
+          {
+            :'operation_type' => :'String',
+            :'operator' => :'String',
+            :'include_objects_with_no_value_set' => :'Boolean',
+            :'comparison_property_name' => :'String',
+            :'default_comparison_value' => :'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::PublicComparativeDatePropertyOperation` 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::PublicComparativeDatePropertyOperation`. 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?(:'operation_type')
+            self.operation_type = attributes[:'operation_type']
+          else
+            self.operation_type = 'COMPARATIVE_DATE'
+          end
+
+          if attributes.key?(:'operator')
+            self.operator = attributes[:'operator']
+          end
+
+          if attributes.key?(:'include_objects_with_no_value_set')
+            self.include_objects_with_no_value_set = attributes[:'include_objects_with_no_value_set']
+          end
+
+          if attributes.key?(:'comparison_property_name')
+            self.comparison_property_name = attributes[:'comparison_property_name']
+          end
+
+          if attributes.key?(:'default_comparison_value')
+            self.default_comparison_value = attributes[:'default_comparison_value']
+          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 @operation_type.nil?
+            invalid_properties.push('invalid value for "operation_type", operation_type cannot be nil.')
+          end
+
+          if @operator.nil?
+            invalid_properties.push('invalid value for "operator", operator cannot be nil.')
+          end
+
+          if @include_objects_with_no_value_set.nil?
+            invalid_properties.push('invalid value for "include_objects_with_no_value_set", include_objects_with_no_value_set cannot be nil.')
+          end
+
+          if @comparison_property_name.nil?
+            invalid_properties.push('invalid value for "comparison_property_name", comparison_property_name 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 @operation_type.nil?
+          operation_type_validator = EnumAttributeValidator.new('String', ["COMPARATIVE_DATE"])
+          return false unless operation_type_validator.valid?(@operation_type)
+          return false if @operator.nil?
+          return false if @include_objects_with_no_value_set.nil?
+          return false if @comparison_property_name.nil?
+          true
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] operation_type Object to be assigned
+        def operation_type=(operation_type)
+          validator = EnumAttributeValidator.new('String', ["COMPARATIVE_DATE"])
+          unless validator.valid?(operation_type)
+            fail ArgumentError, "invalid value for \"operation_type\", must be one of #{validator.allowable_values}."
+          end
+          @operation_type = operation_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 &&
+              operation_type == o.operation_type &&
+              operator == o.operator &&
+              include_objects_with_no_value_set == o.include_objects_with_no_value_set &&
+              comparison_property_name == o.comparison_property_name &&
+              default_comparison_value == o.default_comparison_value
+        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
+          [operation_type, operator, include_objects_with_no_value_set, comparison_property_name, default_comparison_value].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