class ShipEngine::ConnectFedexUkRequestBody
A Fedex UK account information request body
Attributes
Account number
Boolean signaling agreement to the Fedex End User License Agreement
The city
The company
Country code
The email address
First name
Last name
Meter number
Nickname
Phone number
Postal Code
State
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 64 def self.attribute_map { :'account_number' => :'account_number', :'address1' => :'address1', :'address2' => :'address2', :'city' => :'city', :'company' => :'company', :'country_code' => :'country_code', :'email' => :'email', :'first_name' => :'first_name', :'last_name' => :'last_name', :'phone' => :'phone', :'postal_code' => :'postal_code', :'state' => :'state', :'nickname' => :'nickname', :'agree_to_eula' => :'agree_to_eula', :'meter_number' => :'meter_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_fedex_uk_request_body.rb, line 530 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_fedex_uk_request_body.rb, line 113 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::ConnectFedexUkRequestBody` 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?(:'account_number') self.account_number = attributes[:'account_number'] end if attributes.key?(:'address1') self.address1 = attributes[:'address1'] end if attributes.key?(:'address2') self.address2 = attributes[:'address2'] end if attributes.key?(:'city') self.city = attributes[:'city'] end if attributes.key?(:'company') self.company = attributes[:'company'] end if attributes.key?(:'country_code') self.country_code = attributes[:'country_code'] end if attributes.key?(:'email') self.email = attributes[:'email'] end if attributes.key?(:'first_name') self.first_name = attributes[:'first_name'] end if attributes.key?(:'last_name') self.last_name = attributes[:'last_name'] end if attributes.key?(:'phone') self.phone = attributes[:'phone'] 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?(:'nickname') self.nickname = attributes[:'nickname'] end if attributes.key?(:'agree_to_eula') self.agree_to_eula = attributes[:'agree_to_eula'] end if attributes.key?(:'meter_number') self.meter_number = attributes[:'meter_number'] end end
List of attributes with nullable: true
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 106 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 85 def self.openapi_types { :'account_number' => :'String', :'address1' => :'String', :'address2' => :'String', :'city' => :'String', :'company' => :'String', :'country_code' => :'String', :'email' => :'String', :'first_name' => :'String', :'last_name' => :'String', :'phone' => :'String', :'postal_code' => :'String', :'state' => :'String', :'nickname' => :'String', :'agree_to_eula' => :'Boolean', :'meter_number' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 495 def ==(o) return true if self.equal?(o) self.class == o.class && account_number == o.account_number && address1 == o.address1 && address2 == o.address2 && city == o.city && company == o.company && country_code == o.country_code && email == o.email && first_name == o.first_name && last_name == o.last_name && phone == o.phone && postal_code == o.postal_code && state == o.state && nickname == o.nickname && agree_to_eula == o.agree_to_eula && meter_number == o.meter_number 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_fedex_uk_request_body.rb, line 558 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_fedex_uk_request_body.rb, line 627 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_fedex_uk_request_body.rb, line 325 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
Custom attribute writer method with validation @param [Object] address1 Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 339 def address1=(address1) if address1.nil? fail ArgumentError, 'address1 cannot be nil' end if address1.to_s.length < 1 fail ArgumentError, 'invalid value for "address1", the character length must be great than or equal to 1.' end @address1 = address1 end
Custom attribute writer method with validation @param [Object] address2 Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 353 def address2=(address2) if !address2.nil? && address2.to_s.length < 1 fail ArgumentError, 'invalid value for "address2", the character length must be great than or equal to 1.' end @address2 = address2 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_fedex_uk_request_body.rb, line 537 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
Custom attribute writer method with validation @param [Object] city Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 363 def city=(city) if city.nil? fail ArgumentError, 'city cannot be nil' end if city.to_s.length < 1 fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 1.' end @city = city end
Custom attribute writer method with validation @param [Object] company Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 377 def company=(company) if !company.nil? && company.to_s.length < 1 fail ArgumentError, 'invalid value for "company", the character length must be great than or equal to 1.' end @company = company end
Custom attribute writer method with validation @param [Object] country_code
Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 387 def country_code=(country_code) if country_code.nil? fail ArgumentError, 'country_code cannot be nil' end if country_code.to_s.length < 1 fail ArgumentError, 'invalid value for "country_code", the character length must be great than or equal to 1.' end @country_code = country_code end
@see the `==` method @param [Object] Object to be compared
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 517 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] first_name
Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 401 def first_name=(first_name) if first_name.nil? fail ArgumentError, 'first_name cannot be nil' end if first_name.to_s.length < 1 fail ArgumentError, 'invalid value for "first_name", the character length must be great than or equal to 1.' end @first_name = first_name end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 523 def hash [account_number, address1, address2, city, company, country_code, email, first_name, last_name, phone, postal_code, state, nickname, agree_to_eula, meter_number].hash end
Custom attribute writer method with validation @param [Object] last_name
Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 415 def last_name=(last_name) if last_name.nil? fail ArgumentError, 'last_name cannot be nil' end if last_name.to_s.length < 1 fail ArgumentError, 'invalid value for "last_name", the character length must be great than or equal to 1.' end @last_name = last_name 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_fedex_uk_request_body.rb, line 187 def list_invalid_properties invalid_properties = Array.new 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 @address1.nil? invalid_properties.push('invalid value for "address1", address1 cannot be nil.') end if @address1.to_s.length < 1 invalid_properties.push('invalid value for "address1", the character length must be great than or equal to 1.') end if !@address2.nil? && @address2.to_s.length < 1 invalid_properties.push('invalid value for "address2", the character length must be great than or equal to 1.') end if @city.nil? invalid_properties.push('invalid value for "city", city cannot be nil.') end if @city.to_s.length < 1 invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.') end if !@company.nil? && @company.to_s.length < 1 invalid_properties.push('invalid value for "company", the character length must be great than or equal to 1.') end if @country_code.nil? invalid_properties.push('invalid value for "country_code", country_code cannot be nil.') end if @country_code.to_s.length < 1 invalid_properties.push('invalid value for "country_code", the character length must be great than or equal to 1.') end if @email.nil? invalid_properties.push('invalid value for "email", email cannot be nil.') end if @first_name.nil? invalid_properties.push('invalid value for "first_name", first_name cannot be nil.') end if @first_name.to_s.length < 1 invalid_properties.push('invalid value for "first_name", the character length must be great than or equal to 1.') end if @last_name.nil? invalid_properties.push('invalid value for "last_name", last_name cannot be nil.') end if @last_name.to_s.length < 1 invalid_properties.push('invalid value for "last_name", the character length must be great than or equal to 1.') end if @phone.nil? invalid_properties.push('invalid value for "phone", phone cannot be nil.') end if @phone.to_s.length < 1 invalid_properties.push('invalid value for "phone", the character length must be great than or equal to 1.') end if @postal_code.nil? invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.') end if @postal_code.to_s.length < 1 invalid_properties.push('invalid value for "postal_code", the character length must be great than or equal to 1.') end if @state.nil? invalid_properties.push('invalid value for "state", state cannot be nil.') end if @state.to_s.length < 1 invalid_properties.push('invalid value for "state", the character length must be great than or equal to 1.') end 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 @agree_to_eula.nil? invalid_properties.push('invalid value for "agree_to_eula", agree_to_eula cannot be nil.') end if !@meter_number.nil? && @meter_number.to_s.length < 1 invalid_properties.push('invalid value for "meter_number", the character length must be great than or equal to 1.') end invalid_properties end
Custom attribute writer method with validation @param [Object] meter_number
Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 485 def meter_number=(meter_number) if !meter_number.nil? && meter_number.to_s.length < 1 fail ArgumentError, 'invalid value for "meter_number", the character length must be great than or equal to 1.' end @meter_number = meter_number end
Custom attribute writer method with validation @param [Object] nickname Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 471 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] phone Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 429 def phone=(phone) if phone.nil? fail ArgumentError, 'phone cannot be nil' end if phone.to_s.length < 1 fail ArgumentError, 'invalid value for "phone", the character length must be great than or equal to 1.' end @phone = phone end
Custom attribute writer method with validation @param [Object] postal_code
Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 443 def postal_code=(postal_code) if postal_code.nil? fail ArgumentError, 'postal_code cannot be nil' end if postal_code.to_s.length < 1 fail ArgumentError, 'invalid value for "postal_code", the character length must be great than or equal to 1.' end @postal_code = postal_code end
Custom attribute writer method with validation @param [Object] state Value to be assigned
# File lib/ship_engine/models/connect_fedex_uk_request_body.rb, line 457 def state=(state) if state.nil? fail ArgumentError, 'state cannot be nil' end if state.to_s.length < 1 fail ArgumentError, 'invalid value for "state", the character length must be great than or equal to 1.' end @state = state 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_fedex_uk_request_body.rb, line 609 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_fedex_uk_request_body.rb, line 597 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_fedex_uk_request_body.rb, line 294 def valid? return false if @account_number.nil? return false if @account_number.to_s.length < 1 return false if @address1.nil? return false if @address1.to_s.length < 1 return false if !@address2.nil? && @address2.to_s.length < 1 return false if @city.nil? return false if @city.to_s.length < 1 return false if !@company.nil? && @company.to_s.length < 1 return false if @country_code.nil? return false if @country_code.to_s.length < 1 return false if @email.nil? return false if @first_name.nil? return false if @first_name.to_s.length < 1 return false if @last_name.nil? return false if @last_name.to_s.length < 1 return false if @phone.nil? return false if @phone.to_s.length < 1 return false if @postal_code.nil? return false if @postal_code.to_s.length < 1 return false if @state.nil? return false if @state.to_s.length < 1 return false if @nickname.nil? return false if @nickname.to_s.length < 1 return false if @agree_to_eula.nil? return false if !@meter_number.nil? && @meter_number.to_s.length < 1 true end