Class: AmznSpApi::MerchantFulfillmentApiModel::LabelFormatOption

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant_fulfillment_api_model/models/label_format_option.rb

Overview

The label format details and whether to include a packing slip.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LabelFormatOption

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 43

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::MerchantFulfillmentApiModel::LabelFormatOption` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::MerchantFulfillmentApiModel::LabelFormatOption`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.include_packing_slip_with_label = attributes[:include_packing_slip_with_label] if attributes.key?(:include_packing_slip_with_label)

  return unless attributes.key?(:label_format)

  self.label_format = attributes[:label_format]
end

Instance Attribute Details

#include_packing_slip_with_label ⇒ Object

When true, include a packing slip with the label.



16
17
18
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 16

def include_packing_slip_with_label
  @include_packing_slip_with_label
end

#label_format ⇒ Object

Returns the value of attribute label_format.



18
19
20
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 18

def label_format
  @label_format
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



21
22
23
24
25
26
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 21

def self.attribute_map
  {
    'include_packing_slip_with_label': :IncludePackingSlipWithLabel,
    'label_format': :LabelFormat
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



97
98
99
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 97

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



37
38
39
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 37

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



29
30
31
32
33
34
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 29

def self.openapi_types
  {
    'include_packing_slip_with_label': :Object,
    'label_format': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



74
75
76
77
78
79
80
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 74

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    include_packing_slip_with_label == other.include_packing_slip_with_label &&
    label_format == other.label_format
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 126

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
    AmznSpApi::MerchantFulfillmentApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 195

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 104

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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


84
85
86
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 84

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



90
91
92
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 90

def hash
  [include_packing_slip_with_label, label_format].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



62
63
64
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 62

def list_invalid_properties
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 171

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 177

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



165
166
167
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 165

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



68
69
70
 
# File 'lib/merchant_fulfillment_api_model/models/label_format_option.rb', line 68

def valid?
  true
end