hubspot-api-client 1.0.1 → 2.0.0

data/lib/hubspot/codegen/crm/properties/models/property_create.rb

@@ -13,363 +13,359 @@ OpenAPI Generator version: 4.2.2
 require 'date'
 
 module Hubspot
-  module Client
-    module Crm
-      module Properties
-        module Models
-          class PropertyCreate
-            # The internal property name, which must be used when referencing the property via the API.
-            attr_accessor :name
-
-            # A human-readable property label that will be shown in HubSpot.
-            attr_accessor :label
-
-            # The data type of the property.
-            attr_accessor :type
-
-            # Controls how the property appears in HubSpot.
-            attr_accessor :field_type
-
-            # The name of the property group the property belongs to.
-            attr_accessor :group_name
-
-            # A description of the property that will be shown as help text in HubSpot.
-            attr_accessor :description
-
-            # A list of valid options for the property. This field is required for enumerated properties.
-            attr_accessor :options
-
-            # Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.
-            attr_accessor :display_order
-
-            # Whether or not the property's value must be unique. Once set, this can't be changed.
-            attr_accessor :has_unique_value
-
-            # If true, the property won't be visible and can't be used in HubSpot.
-            attr_accessor :hidden
-
-            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
+  module Crm
+    module Properties
+      class PropertyCreate
+        # The internal property name, which must be used when referencing the property via the API.
+        attr_accessor :name
 
-              def valid?(value)
-                !value || allowable_values.include?(value)
-              end
-            end
+        # A human-readable property label that will be shown in HubSpot.
+        attr_accessor :label
 
-            # Attribute mapping from ruby-style variable name to JSON key.
-            def self.attribute_map
-              {
-                :'name' => :'name',
-                :'label' => :'label',
-                :'type' => :'type',
-                :'field_type' => :'fieldType',
-                :'group_name' => :'groupName',
-                :'description' => :'description',
-                :'options' => :'options',
-                :'display_order' => :'displayOrder',
-                :'has_unique_value' => :'hasUniqueValue',
-                :'hidden' => :'hidden'
-              }
-            end
+        # The data type of the property.
+        attr_accessor :type
 
-            # Attribute type mapping.
-            def self.openapi_types
-              {
-                :'name' => :'String',
-                :'label' => :'String',
-                :'type' => :'String',
-                :'field_type' => :'String',
-                :'group_name' => :'String',
-                :'description' => :'String',
-                :'options' => :'Array<OptionInput>',
-                :'display_order' => :'Integer',
-                :'has_unique_value' => :'Boolean',
-                :'hidden' => :'Boolean'
-              }
-            end
+        # Controls how the property appears in HubSpot.
+        attr_accessor :field_type
 
-            # List of attributes with nullable: true
-            def self.openapi_nullable
-              Set.new([
-              ])
-            end
+        # The name of the property group the property belongs to.
+        attr_accessor :group_name
 
-            # 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::Client::Crm::Properties::Models::PropertyCreate` initialize method"
-              end
+        # A description of the property that will be shown as help text in HubSpot.
+        attr_accessor :description
 
-              # 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::Client::Crm::Properties::Models::PropertyCreate`. 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
-              }
+        # A list of valid options for the property. This field is required for enumerated properties.
+        attr_accessor :options
 
-              if attributes.key?(:'name')
-                self.name = attributes[:'name']
-              end
+        # Properties are displayed in order starting with the lowest positive integer value. Values of -1 will cause the property to be displayed after any positive values.
+        attr_accessor :display_order
 
-              if attributes.key?(:'label')
-                self.label = attributes[:'label']
-              end
+        # Whether or not the property's value must be unique. Once set, this can't be changed.
+        attr_accessor :has_unique_value
 
-              if attributes.key?(:'type')
-                self.type = attributes[:'type']
-              end
+        # If true, the property won't be visible and can't be used in HubSpot.
+        attr_accessor :hidden
 
-              if attributes.key?(:'field_type')
-                self.field_type = attributes[:'field_type']
-              end
+        class EnumAttributeValidator
+          attr_reader :datatype
+          attr_reader :allowable_values
 
-              if attributes.key?(:'group_name')
-                self.group_name = attributes[:'group_name']
+          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
 
-              if attributes.key?(:'description')
-                self.description = attributes[:'description']
-              end
+          def valid?(value)
+            !value || allowable_values.include?(value)
+          end
+        end
 
-              if attributes.key?(:'options')
-                if (value = attributes[:'options']).is_a?(Array)
-                  self.options = value
-                end
-              end
+        # Attribute mapping from ruby-style variable name to JSON key.
+        def self.attribute_map
+          {
+            :'name' => :'name',
+            :'label' => :'label',
+            :'type' => :'type',
+            :'field_type' => :'fieldType',
+            :'group_name' => :'groupName',
+            :'description' => :'description',
+            :'options' => :'options',
+            :'display_order' => :'displayOrder',
+            :'has_unique_value' => :'hasUniqueValue',
+            :'hidden' => :'hidden'
+          }
+        end
 
-              if attributes.key?(:'display_order')
-                self.display_order = attributes[:'display_order']
-              end
+        # Attribute type mapping.
+        def self.openapi_types
+          {
+            :'name' => :'String',
+            :'label' => :'String',
+            :'type' => :'String',
+            :'field_type' => :'String',
+            :'group_name' => :'String',
+            :'description' => :'String',
+            :'options' => :'Array<OptionInput>',
+            :'display_order' => :'Integer',
+            :'has_unique_value' => :'Boolean',
+            :'hidden' => :'Boolean'
+          }
+        end
 
-              if attributes.key?(:'has_unique_value')
-                self.has_unique_value = attributes[:'has_unique_value']
-              end
+        # List of attributes with nullable: true
+        def self.openapi_nullable
+          Set.new([
+          ])
+        end
 
-              if attributes.key?(:'hidden')
-                self.hidden = attributes[:'hidden']
-              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::Properties::PropertyCreate` 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::Properties::PropertyCreate`. 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
+          }
 
-            # 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 @name.nil?
-                invalid_properties.push('invalid value for "name", name cannot be nil.')
-              end
+          if attributes.key?(:'name')
+            self.name = attributes[:'name']
+          end
 
-              if @label.nil?
-                invalid_properties.push('invalid value for "label", label cannot be nil.')
-              end
+          if attributes.key?(:'label')
+            self.label = attributes[:'label']
+          end
 
-              if @type.nil?
-                invalid_properties.push('invalid value for "type", type cannot be nil.')
-              end
+          if attributes.key?(:'type')
+            self.type = attributes[:'type']
+          end
 
-              if @field_type.nil?
-                invalid_properties.push('invalid value for "field_type", field_type cannot be nil.')
-              end
+          if attributes.key?(:'field_type')
+            self.field_type = attributes[:'field_type']
+          end
 
-              if @group_name.nil?
-                invalid_properties.push('invalid value for "group_name", group_name cannot be nil.')
-              end
+          if attributes.key?(:'group_name')
+            self.group_name = attributes[:'group_name']
+          end
 
-              invalid_properties
-            end
+          if attributes.key?(:'description')
+            self.description = attributes[:'description']
+          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 @name.nil?
-              return false if @label.nil?
-              return false if @type.nil?
-              type_validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration"])
-              return false unless type_validator.valid?(@type)
-              return false if @field_type.nil?
-              field_type_validator = EnumAttributeValidator.new('String', ["textarea", "text", "date", "file", "number", "select", "radio", "checkbox", "booleancheckbox"])
-              return false unless field_type_validator.valid?(@field_type)
-              return false if @group_name.nil?
-              true
+          if attributes.key?(:'options')
+            if (value = attributes[:'options']).is_a?(Array)
+              self.options = value
             end
+          end
 
-            # Custom attribute writer method checking allowed values (enum).
-            # @param [Object] type Object to be assigned
-            def type=(type)
-              validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration"])
-              unless validator.valid?(type)
-                fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
-              end
-              @type = type
-            end
+          if attributes.key?(:'display_order')
+            self.display_order = attributes[:'display_order']
+          end
 
-            # Custom attribute writer method checking allowed values (enum).
-            # @param [Object] field_type Object to be assigned
-            def field_type=(field_type)
-              validator = EnumAttributeValidator.new('String', ["textarea", "text", "date", "file", "number", "select", "radio", "checkbox", "booleancheckbox"])
-              unless validator.valid?(field_type)
-                fail ArgumentError, "invalid value for \"field_type\", must be one of #{validator.allowable_values}."
-              end
-              @field_type = field_type
-            end
+          if attributes.key?(:'has_unique_value')
+            self.has_unique_value = attributes[:'has_unique_value']
+          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 &&
-                  name == o.name &&
-                  label == o.label &&
-                  type == o.type &&
-                  field_type == o.field_type &&
-                  group_name == o.group_name &&
-                  description == o.description &&
-                  options == o.options &&
-                  display_order == o.display_order &&
-                  has_unique_value == o.has_unique_value &&
-                  hidden == o.hidden
-            end
+          if attributes.key?(:'hidden')
+            self.hidden = attributes[:'hidden']
+          end
+        end
 
-            # @see the `==` method
-            # @param [Object] Object to be compared
-            def eql?(o)
-              self == o
-            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 @name.nil?
+            invalid_properties.push('invalid value for "name", name cannot be nil.')
+          end
 
-            # Calculates hash code according to all attributes.
-            # @return [Integer] Hash code
-            def hash
-              [name, label, type, field_type, group_name, description, options, display_order, has_unique_value, hidden].hash
-            end
+          if @label.nil?
+            invalid_properties.push('invalid value for "label", label cannot be nil.')
+          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
+          if @type.nil?
+            invalid_properties.push('invalid value for "type", type cannot be nil.')
+          end
+
+          if @field_type.nil?
+            invalid_properties.push('invalid value for "field_type", field_type cannot be nil.')
+          end
+
+          if @group_name.nil?
+            invalid_properties.push('invalid value for "group_name", group_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 @name.nil?
+          return false if @label.nil?
+          return false if @type.nil?
+          type_validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration"])
+          return false unless type_validator.valid?(@type)
+          return false if @field_type.nil?
+          field_type_validator = EnumAttributeValidator.new('String', ["textarea", "text", "date", "file", "number", "select", "radio", "checkbox", "booleancheckbox"])
+          return false unless field_type_validator.valid?(@field_type)
+          return false if @group_name.nil?
+          true
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] type Object to be assigned
+        def type=(type)
+          validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration"])
+          unless validator.valid?(type)
+            fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+          end
+          @type = type
+        end
+
+        # Custom attribute writer method checking allowed values (enum).
+        # @param [Object] field_type Object to be assigned
+        def field_type=(field_type)
+          validator = EnumAttributeValidator.new('String', ["textarea", "text", "date", "file", "number", "select", "radio", "checkbox", "booleancheckbox"])
+          unless validator.valid?(field_type)
+            fail ArgumentError, "invalid value for \"field_type\", must be one of #{validator.allowable_values}."
+          end
+          @field_type = field_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 &&
+              name == o.name &&
+              label == o.label &&
+              type == o.type &&
+              field_type == o.field_type &&
+              group_name == o.group_name &&
+              description == o.description &&
+              options == o.options &&
+              display_order == o.display_order &&
+              has_unique_value == o.has_unique_value &&
+              hidden == o.hidden
+        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
+          [name, label, type, field_type, group_name, description, options, display_order, has_unique_value, hidden].hash
+        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)
-              self.class.openapi_types.each_pair do |key, type|
-                if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+        # 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)
+          self.class.openapi_types.each_pair do |key, type|
+            if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+          end
 
-              self
-            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 :DateTime
-                DateTime.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
-                Hubspot::Client::Crm::Properties::Models.const_get(type).build_from_hash(value)
+        # 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 :DateTime
+            DateTime.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
+            Hubspot::Crm::Properties.const_get(type).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
+        # 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
+        # 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
+        # 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
+        # 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