class AmzSpApi::FulfillmentOutboundApiModel::GetFulfillmentPreviewRequest
The request body schema for the getFulfillmentPreview operation.
Attributes
A list of features and their fulfillment policies to apply to the order.
Specifies whether to return fulfillment order previews that are for COD (Cash On Delivery). Possible values: * true - Returns all fulfillment order previews (both for COD and not for COD). * false - Returns only fulfillment order previews that are not for COD.
Specifies whether to return the ScheduledDeliveryInfo
response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo
response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery.
The marketplace the fulfillment order is placed against.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 36 def self.attribute_map { :'marketplace_id' => :'marketplaceId', :'address' => :'address', :'items' => :'items', :'shipping_speed_categories' => :'shippingSpeedCategories', :'include_cod_fulfillment_preview' => :'includeCODFulfillmentPreview', :'include_delivery_windows' => :'includeDeliveryWindows', :'feature_constraints' => :'featureConstraints' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 165 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/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 69 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::FulfillmentOutboundApiModel::GetFulfillmentPreviewRequest` 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::FulfillmentOutboundApiModel::GetFulfillmentPreviewRequest`. 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?(:'marketplace_id') self.marketplace_id = attributes[:'marketplace_id'] end if attributes.key?(:'address') self.address = attributes[:'address'] end if attributes.key?(:'items') self.items = attributes[:'items'] end if attributes.key?(:'shipping_speed_categories') self.shipping_speed_categories = attributes[:'shipping_speed_categories'] end if attributes.key?(:'include_cod_fulfillment_preview') self.include_cod_fulfillment_preview = attributes[:'include_cod_fulfillment_preview'] end if attributes.key?(:'include_delivery_windows') self.include_delivery_windows = attributes[:'include_delivery_windows'] end if attributes.key?(:'feature_constraints') if (value = attributes[:'feature_constraints']).is_a?(Array) self.feature_constraints = value end end end
List of attributes with nullable: true
# File lib/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 62 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 49 def self.openapi_types { :'marketplace_id' => :'Object', :'address' => :'Object', :'items' => :'Object', :'shipping_speed_categories' => :'Object', :'include_cod_fulfillment_preview' => :'Object', :'include_delivery_windows' => :'Object', :'feature_constraints' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 138 def ==(o) return true if self.equal?(o) self.class == o.class && marketplace_id == o.marketplace_id && address == o.address && items == o.items && shipping_speed_categories == o.shipping_speed_categories && include_cod_fulfillment_preview == o.include_cod_fulfillment_preview && include_delivery_windows == o.include_delivery_windows && feature_constraints == o.feature_constraints 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/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 195 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::FulfillmentOutboundApiModel.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/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 264 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/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 172 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/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 152 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 158 def hash [marketplace_id, address, items, shipping_speed_categories, include_cod_fulfillment_preview, include_delivery_windows, feature_constraints].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 115 def list_invalid_properties invalid_properties = Array.new if @address.nil? invalid_properties.push('invalid value for "address", address cannot be nil.') end if @items.nil? invalid_properties.push('invalid value for "items", items 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/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 246 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/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 234 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/fulfillment-outbound-api-model/models/get_fulfillment_preview_request.rb, line 130 def valid? return false if @address.nil? return false if @items.nil? true end