class ConnectWise::ShipmentMethod
Attributes
Metadata
of the entity
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 43 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'default_flag' => :'defaultFlag', :'tracking_url' => :'trackingUrl', :'shipping_type' => :'shippingType', :'_info' => :'_info' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 68 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'defaultFlag') self.default_flag = attributes[:'defaultFlag'] end if attributes.has_key?(:'trackingUrl') self.tracking_url = attributes[:'trackingUrl'] end if attributes.has_key?(:'shippingType') self.shipping_type = attributes[:'shippingType'] end if attributes.has_key?(:'_info') self._info = attributes[:'_info'] end end
Attribute type mapping.
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 55 def self.swagger_types { :'id' => :'Integer', :'name' => :'String', :'default_flag' => :'BOOLEAN', :'tracking_url' => :'String', :'shipping_type' => :'String', :'_info' => :'Metadata' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 167 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && default_flag == o.default_flag && tracking_url == o.tracking_url && shipping_type == o.shipping_type && _info == o._info 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/connectwise-ruby-sdk/models/shipment_method.rb, line 214 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 temp_model = ConnectWise.const_get(type).new temp_model.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/connectwise-ruby-sdk/models/shipment_method.rb, line 280 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 193 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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/connectwise-ruby-sdk/models/shipment_method.rb, line 180 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 186 def hash [id, name, default_flag, tracking_url, shipping_type, _info].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 102 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push("invalid value for 'name', name cannot be nil.") end if @name.to_s.length > 50 invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 50.") end if !@tracking_url.nil? && @tracking_url.to_s.length > 200 invalid_properties.push("invalid value for 'tracking_url', the character length must be smaller than or equal to 200.") end return invalid_properties end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 132 def name=(name) if name.nil? fail ArgumentError, "name cannot be nil" end if name.to_s.length > 50 fail ArgumentError, "invalid value for 'name', the character length must be smaller than or equal to 50." end @name = name end
Custom attribute writer method checking allowed values (enum). @param [Object] shipping_type
Object to be assigned
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 157 def shipping_type=(shipping_type) validator = EnumAttributeValidator.new('String', ["None", "FedExTwoDay", "FedExPriority", "FedExGround", "UpsNextDay", "UpsSecondDay", "UpsGround", "CourierService", "UspsPriority", "UspsExpress"]) unless validator.valid?(shipping_type) fail ArgumentError, "invalid value for 'shipping_type', must be one of #{validator.allowable_values}." end @shipping_type = shipping_type end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 266 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 254 def to_s to_hash.to_s end
Custom attribute writer method with validation @param [Object] tracking_url
Value to be assigned
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 146 def tracking_url=(tracking_url) if !tracking_url.nil? && tracking_url.to_s.length > 200 fail ArgumentError, "invalid value for 'tracking_url', the character length must be smaller than or equal to 200." end @tracking_url = tracking_url end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/connectwise-ruby-sdk/models/shipment_method.rb, line 121 def valid? return false if @name.nil? return false if @name.to_s.length > 50 return false if !@tracking_url.nil? && @tracking_url.to_s.length > 200 shipping_type_validator = EnumAttributeValidator.new('String', ["None", "FedExTwoDay", "FedExPriority", "FedExGround", "UpsNextDay", "UpsSecondDay", "UpsGround", "CourierService", "UspsPriority", "UspsExpress"]) return false unless shipping_type_validator.valid?(@shipping_type) return true end