constant_contact_client 1.2.0 → 1.5.0

data/lib/constant_contact_client/models/address_dto.rb

@@ -0,0 +1,604 @@
+=begin
+#Constant Contact API v3
+
+#Swagger build version 3.0.161
+
+The version of the OpenAPI document: 1.0.220
+Contact: webservices@constantcontact.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ConstantContactClient
+  class AddressDto
+    # The address type. Only `EVENT` is currently supported.
+    attr_accessor :address_type
+
+    # The first line of the address where the event takes place.
+    attr_accessor :line1
+
+    # The second line of the address where the event takes place.
+    attr_accessor :line2
+
+    # The city where the event takes place.
+    attr_accessor :city
+
+    # Name of the country where the event takes place.
+    attr_accessor :country
+
+    # The country code associated with the country where the event takes place.
+    attr_accessor :country_code
+
+    # The create time of the event.
+    attr_accessor :create_time
+
+    # The last modification time of the event.
+    attr_accessor :last_update_time
+
+    # The latitude number indicating where the event takes place.
+    attr_accessor :latitude
+
+    # The longitude number indicating where the event takes place.
+    attr_accessor :longitude
+
+    # The venue name where the event takes place.
+    attr_accessor :location_name
+
+    # The address postal code.
+    attr_accessor :postal_code
+
+    # The State/Province where the event takes place.
+    attr_accessor :state
+
+    # The state code where the event takes place.
+    attr_accessor :state_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address_type' => :'address_type',
+        :'line1' => :'line1',
+        :'line2' => :'line2',
+        :'city' => :'city',
+        :'country' => :'country',
+        :'country_code' => :'country_code',
+        :'create_time' => :'create_time',
+        :'last_update_time' => :'last_update_time',
+        :'latitude' => :'latitude',
+        :'longitude' => :'longitude',
+        :'location_name' => :'location_name',
+        :'postal_code' => :'postal_code',
+        :'state' => :'state',
+        :'state_code' => :'state_code'
+      }
+    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
+      {
+        :'address_type' => :'String',
+        :'line1' => :'String',
+        :'line2' => :'String',
+        :'city' => :'String',
+        :'country' => :'String',
+        :'country_code' => :'String',
+        :'create_time' => :'String',
+        :'last_update_time' => :'String',
+        :'latitude' => :'Float',
+        :'longitude' => :'Float',
+        :'location_name' => :'String',
+        :'postal_code' => :'String',
+        :'state' => :'String',
+        :'state_code' => :'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 `ConstantContactClient::AddressDto` 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 `ConstantContactClient::AddressDto`. 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?(:'address_type')
+        self.address_type = attributes[:'address_type']
+      else
+        self.address_type = nil
+      end
+
+      if attributes.key?(:'line1')
+        self.line1 = attributes[:'line1']
+      end
+
+      if attributes.key?(:'line2')
+        self.line2 = attributes[:'line2']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      end
+
+      if attributes.key?(:'create_time')
+        self.create_time = attributes[:'create_time']
+      end
+
+      if attributes.key?(:'last_update_time')
+        self.last_update_time = attributes[:'last_update_time']
+      end
+
+      if attributes.key?(:'latitude')
+        self.latitude = attributes[:'latitude']
+      end
+
+      if attributes.key?(:'longitude')
+        self.longitude = attributes[:'longitude']
+      end
+
+      if attributes.key?(:'location_name')
+        self.location_name = attributes[:'location_name']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'state_code')
+        self.state_code = attributes[:'state_code']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @address_type.nil?
+        invalid_properties.push('invalid value for "address_type", address_type cannot be nil.')
+      end
+
+      if !@line1.nil? && @line1.to_s.length > 80
+        invalid_properties.push('invalid value for "line1", the character length must be smaller than or equal to 80.')
+      end
+
+      if !@line1.nil? && @line1.to_s.length < 0
+        invalid_properties.push('invalid value for "line1", the character length must be great than or equal to 0.')
+      end
+
+      if !@line2.nil? && @line2.to_s.length > 80
+        invalid_properties.push('invalid value for "line2", the character length must be smaller than or equal to 80.')
+      end
+
+      if !@line2.nil? && @line2.to_s.length < 0
+        invalid_properties.push('invalid value for "line2", the character length must be great than or equal to 0.')
+      end
+
+      if !@city.nil? && @city.to_s.length > 80
+        invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 80.')
+      end
+
+      if !@city.nil? && @city.to_s.length < 0
+        invalid_properties.push('invalid value for "city", the character length must be great than or equal to 0.')
+      end
+
+      if !@country.nil? && @country.to_s.length > 128
+        invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 128.')
+      end
+
+      if !@country.nil? && @country.to_s.length < 0
+        invalid_properties.push('invalid value for "country", the character length must be great than or equal to 0.')
+      end
+
+      if !@country_code.nil? && @country_code.to_s.length > 2
+        invalid_properties.push('invalid value for "country_code", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@country_code.nil? && @country_code.to_s.length < 0
+        invalid_properties.push('invalid value for "country_code", the character length must be great than or equal to 0.')
+      end
+
+      if !@location_name.nil? && @location_name.to_s.length > 100
+        invalid_properties.push('invalid value for "location_name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@location_name.nil? && @location_name.to_s.length < 0
+        invalid_properties.push('invalid value for "location_name", the character length must be great than or equal to 0.')
+      end
+
+      if !@postal_code.nil? && @postal_code.to_s.length > 25
+        invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 25.')
+      end
+
+      if !@postal_code.nil? && @postal_code.to_s.length < 0
+        invalid_properties.push('invalid value for "postal_code", the character length must be great than or equal to 0.')
+      end
+
+      if !@state.nil? && @state.to_s.length > 80
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 80.')
+      end
+
+      if !@state.nil? && @state.to_s.length < 0
+        invalid_properties.push('invalid value for "state", the character length must be great than or equal to 0.')
+      end
+
+      if !@state_code.nil? && @state_code.to_s.length > 2
+        invalid_properties.push('invalid value for "state_code", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@state_code.nil? && @state_code.to_s.length < 0
+        invalid_properties.push('invalid value for "state_code", the character length must be great than or equal to 0.')
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @address_type.nil?
+      return false if !@line1.nil? && @line1.to_s.length > 80
+      return false if !@line1.nil? && @line1.to_s.length < 0
+      return false if !@line2.nil? && @line2.to_s.length > 80
+      return false if !@line2.nil? && @line2.to_s.length < 0
+      return false if !@city.nil? && @city.to_s.length > 80
+      return false if !@city.nil? && @city.to_s.length < 0
+      return false if !@country.nil? && @country.to_s.length > 128
+      return false if !@country.nil? && @country.to_s.length < 0
+      return false if !@country_code.nil? && @country_code.to_s.length > 2
+      return false if !@country_code.nil? && @country_code.to_s.length < 0
+      return false if !@location_name.nil? && @location_name.to_s.length > 100
+      return false if !@location_name.nil? && @location_name.to_s.length < 0
+      return false if !@postal_code.nil? && @postal_code.to_s.length > 25
+      return false if !@postal_code.nil? && @postal_code.to_s.length < 0
+      return false if !@state.nil? && @state.to_s.length > 80
+      return false if !@state.nil? && @state.to_s.length < 0
+      return false if !@state_code.nil? && @state_code.to_s.length > 2
+      return false if !@state_code.nil? && @state_code.to_s.length < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] line1 Value to be assigned
+    def line1=(line1)
+      if line1.nil?
+        fail ArgumentError, 'line1 cannot be nil'
+      end
+
+      if line1.to_s.length > 80
+        fail ArgumentError, 'invalid value for "line1", the character length must be smaller than or equal to 80.'
+      end
+
+      if line1.to_s.length < 0
+        fail ArgumentError, 'invalid value for "line1", the character length must be great than or equal to 0.'
+      end
+
+      @line1 = line1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] line2 Value to be assigned
+    def line2=(line2)
+      if line2.nil?
+        fail ArgumentError, 'line2 cannot be nil'
+      end
+
+      if line2.to_s.length > 80
+        fail ArgumentError, 'invalid value for "line2", the character length must be smaller than or equal to 80.'
+      end
+
+      if line2.to_s.length < 0
+        fail ArgumentError, 'invalid value for "line2", the character length must be great than or equal to 0.'
+      end
+
+      @line2 = line2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      if city.to_s.length > 80
+        fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 80.'
+      end
+
+      if city.to_s.length < 0
+        fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 0.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if country.nil?
+        fail ArgumentError, 'country cannot be nil'
+      end
+
+      if country.to_s.length > 128
+        fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 128.'
+      end
+
+      if country.to_s.length < 0
+        fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 0.'
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_code Value to be assigned
+    def country_code=(country_code)
+      if country_code.nil?
+        fail ArgumentError, 'country_code cannot be nil'
+      end
+
+      if country_code.to_s.length > 2
+        fail ArgumentError, 'invalid value for "country_code", the character length must be smaller than or equal to 2.'
+      end
+
+      if country_code.to_s.length < 0
+        fail ArgumentError, 'invalid value for "country_code", the character length must be great than or equal to 0.'
+      end
+
+      @country_code = country_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] location_name Value to be assigned
+    def location_name=(location_name)
+      if location_name.nil?
+        fail ArgumentError, 'location_name cannot be nil'
+      end
+
+      if location_name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "location_name", the character length must be smaller than or equal to 100.'
+      end
+
+      if location_name.to_s.length < 0
+        fail ArgumentError, 'invalid value for "location_name", the character length must be great than or equal to 0.'
+      end
+
+      @location_name = location_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if postal_code.nil?
+        fail ArgumentError, 'postal_code cannot be nil'
+      end
+
+      if postal_code.to_s.length > 25
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 25.'
+      end
+
+      if postal_code.to_s.length < 0
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be great than or equal to 0.'
+      end
+
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
+      end
+
+      if state.to_s.length > 80
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 80.'
+      end
+
+      if state.to_s.length < 0
+        fail ArgumentError, 'invalid value for "state", the character length must be great than or equal to 0.'
+      end
+
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state_code Value to be assigned
+    def state_code=(state_code)
+      if state_code.nil?
+        fail ArgumentError, 'state_code cannot be nil'
+      end
+
+      if state_code.to_s.length > 2
+        fail ArgumentError, 'invalid value for "state_code", the character length must be smaller than or equal to 2.'
+      end
+
+      if state_code.to_s.length < 0
+        fail ArgumentError, 'invalid value for "state_code", the character length must be great than or equal to 0.'
+      end
+
+      @state_code = state_code
+    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 &&
+          address_type == o.address_type &&
+          line1 == o.line1 &&
+          line2 == o.line2 &&
+          city == o.city &&
+          country == o.country &&
+          country_code == o.country_code &&
+          create_time == o.create_time &&
+          last_update_time == o.last_update_time &&
+          latitude == o.latitude &&
+          longitude == o.longitude &&
+          location_name == o.location_name &&
+          postal_code == o.postal_code &&
+          state == o.state &&
+          state_code == o.state_code
+    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
+      [address_type, line1, line2, city, country, country_code, create_time, last_update_time, latitude, longitude, location_name, postal_code, state, state_code].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = ConstantContactClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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