class AmzSpApi::MerchantFulfillmentApiModel::ShippingServiceOptions
Extra services provided by a carrier.
Attributes
When true, the carrier will pick up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK).
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 29 def self.attribute_map { :'delivery_experience' => :'DeliveryExperience', :'declared_value' => :'DeclaredValue', :'carrier_will_pick_up' => :'CarrierWillPickUp', :'carrier_will_pick_up_option' => :'CarrierWillPickUpOption', :'label_format' => :'LabelFormat' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 142 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/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 58 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::MerchantFulfillmentApiModel::ShippingServiceOptions` 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 `AmzSpApi::MerchantFulfillmentApiModel::ShippingServiceOptions`. 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?(:'delivery_experience') self.delivery_experience = attributes[:'delivery_experience'] end if attributes.key?(:'declared_value') self.declared_value = attributes[:'declared_value'] end if attributes.key?(:'carrier_will_pick_up') self.carrier_will_pick_up = attributes[:'carrier_will_pick_up'] end if attributes.key?(:'carrier_will_pick_up_option') self.carrier_will_pick_up_option = attributes[:'carrier_will_pick_up_option'] end if attributes.key?(:'label_format') self.label_format = attributes[:'label_format'] end end
List of attributes with nullable: true
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 51 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 40 def self.openapi_types { :'delivery_experience' => :'Object', :'declared_value' => :'Object', :'carrier_will_pick_up' => :'Object', :'carrier_will_pick_up_option' => :'Object', :'label_format' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 117 def ==(o) return true if self.equal?(o) self.class == o.class && delivery_experience == o.delivery_experience && declared_value == o.declared_value && carrier_will_pick_up == o.carrier_will_pick_up && carrier_will_pick_up_option == o.carrier_will_pick_up_option && label_format == o.label_format 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/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 172 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 AmzSpApi::MerchantFulfillmentApiModel.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/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 241 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/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 149 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]])) elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 129 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 135 def hash [delivery_experience, declared_value, carrier_will_pick_up, carrier_will_pick_up_option, label_format].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 94 def list_invalid_properties invalid_properties = Array.new if @delivery_experience.nil? invalid_properties.push('invalid value for "delivery_experience", delivery_experience cannot be nil.') end if @carrier_will_pick_up.nil? invalid_properties.push('invalid value for "carrier_will_pick_up", carrier_will_pick_up cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 223 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/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 211 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/merchant-fulfillment-api-model/models/shipping_service_options.rb, line 109 def valid? return false if @delivery_experience.nil? return false if @carrier_will_pick_up.nil? true end