class ShipEngine::ConnectOntracRequestBody
An Ontrac account information request body
Attributes
Account number
Nickname
Password
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 28 def self.attribute_map { :'nickname' => :'nickname', :'account_number' => :'account_number', :'password' => :'password' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 187 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 53 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::ConnectOntracRequestBody` 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| h[k.to_sym] = v } if attributes.key?(:'nickname') self.nickname = attributes[:'nickname'] end if attributes.key?(:'account_number') self.account_number = attributes[:'account_number'] end if attributes.key?(:'password') self.password = attributes[:'password'] end end
List of attributes with nullable: true
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 46 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 37 def self.openapi_types { :'nickname' => :'String', :'account_number' => :'String', :'password' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 164 def ==(o) return true if self.equal?(o) self.class == o.class && nickname == o.nickname && account_number == o.account_number && password == o.password end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 215 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 ShipEngine.const_get(type).build_from_hash(value) end 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
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 284 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
Custom attribute writer method with validation @param [Object] account_number
Value to be assigned
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 136 def account_number=(account_number) if account_number.nil? fail ArgumentError, 'account_number cannot be nil' end if account_number.to_s.length < 1 fail ArgumentError, 'invalid value for "account_number", the character length must be great than or equal to 1.' end @account_number = account_number end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 194 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
@see the `==` method @param [Object] Object to be compared
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 174 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 180 def hash [nickname, account_number, password].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 79 def list_invalid_properties invalid_properties = Array.new if @nickname.nil? invalid_properties.push('invalid value for "nickname", nickname cannot be nil.') end if @nickname.to_s.length < 1 invalid_properties.push('invalid value for "nickname", the character length must be great than or equal to 1.') end if @account_number.nil? invalid_properties.push('invalid value for "account_number", account_number cannot be nil.') end if @account_number.to_s.length < 1 invalid_properties.push('invalid value for "account_number", the character length must be great than or equal to 1.') end if @password.nil? invalid_properties.push('invalid value for "password", password cannot be nil.') end if @password.to_s.length < 1 invalid_properties.push('invalid value for "password", the character length must be great than or equal to 1.') end invalid_properties end
Custom attribute writer method with validation @param [Object] nickname Value to be assigned
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 122 def nickname=(nickname) if nickname.nil? fail ArgumentError, 'nickname cannot be nil' end if nickname.to_s.length < 1 fail ArgumentError, 'invalid value for "nickname", the character length must be great than or equal to 1.' end @nickname = nickname end
Custom attribute writer method with validation @param [Object] password Value to be assigned
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 150 def password=(password) if password.nil? fail ArgumentError, 'password cannot be nil' end if password.to_s.length < 1 fail ArgumentError, 'invalid value for "password", the character length must be great than or equal to 1.' end @password = password end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 266 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 254 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ship_engine/models/connect_ontrac_request_body.rb, line 110 def valid? return false if @nickname.nil? return false if @nickname.to_s.length < 1 return false if @account_number.nil? return false if @account_number.to_s.length < 1 return false if @password.nil? return false if @password.to_s.length < 1 true end