class ShipEngine::CreateReturnLabelRequestBody
A create return label request body
Attributes
The label charge event.
The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.
The label image resource that was used to create a custom label image.
The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5" x 11") is only supported for `pdf` format.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ship_engine/models/create_return_label_request_body.rb, line 33 def self.attribute_map { :'charge_event' => :'charge_event', :'label_layout' => :'label_layout', :'label_format' => :'label_format', :'label_download_type' => :'label_download_type', :'label_image_id' => :'label_image_id' } 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/create_return_label_request_body.rb, line 135 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/create_return_label_request_body.rb, line 63 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::CreateReturnLabelRequestBody` 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?(:'charge_event') self.charge_event = attributes[:'charge_event'] end if attributes.key?(:'label_layout') self.label_layout = attributes[:'label_layout'] end if attributes.key?(:'label_format') self.label_format = attributes[:'label_format'] end if attributes.key?(:'label_download_type') self.label_download_type = attributes[:'label_download_type'] end if attributes.key?(:'label_image_id') self.label_image_id = attributes[:'label_image_id'] end end
List of attributes with nullable: true
# File lib/ship_engine/models/create_return_label_request_body.rb, line 55 def self.openapi_nullable Set.new([ :'label_image_id' ]) end
Attribute type mapping.
# File lib/ship_engine/models/create_return_label_request_body.rb, line 44 def self.openapi_types { :'charge_event' => :'LabelChargeEvent', :'label_layout' => :'LabelLayout', :'label_format' => :'LabelFormat', :'label_download_type' => :'LabelDownloadType', :'label_image_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ship_engine/models/create_return_label_request_body.rb, line 110 def ==(o) return true if self.equal?(o) self.class == o.class && charge_event == o.charge_event && label_layout == o.label_layout && label_format == o.label_format && label_download_type == o.label_download_type && label_image_id == o.label_image_id 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/create_return_label_request_body.rb, line 163 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/create_return_label_request_body.rb, line 232 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/ship_engine/models/create_return_label_request_body.rb, line 142 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/create_return_label_request_body.rb, line 122 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ship_engine/models/create_return_label_request_body.rb, line 128 def hash [charge_event, label_layout, label_format, label_download_type, label_image_id].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/create_return_label_request_body.rb, line 97 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ship_engine/models/create_return_label_request_body.rb, line 214 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/create_return_label_request_body.rb, line 202 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/create_return_label_request_body.rb, line 104 def valid? true end