Class: AmzSpApi::VendorDirectFulfillmentShippingApiModel::LabelData

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb

Overview

Details of the shipment label.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LabelData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 62

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::VendorDirectFulfillmentShippingApiModel::LabelData` 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::VendorDirectFulfillmentShippingApiModel::LabelData`. 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?(:'package_identifier')
    self.package_identifier = attributes[:'package_identifier']
  end

  if attributes.key?(:'tracking_number')
    self.tracking_number = attributes[:'tracking_number']
  end

  if attributes.key?(:'ship_method')
    self.ship_method = attributes[:'ship_method']
  end

  if attributes.key?(:'ship_method_name')
    self.ship_method_name = attributes[:'ship_method_name']
  end

  if attributes.key?(:'content')
    self.content = attributes[:'content']
  end
end

Instance Attribute Details

#content ⇒ Object

This field will contain the Base64encoded string of the shipment label content.



30
31
32
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 30

def content
  @content
end

#package_identifier ⇒ Object

Identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level.



18
19
20
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 18

def package_identifier
  @package_identifier
end

#ship_method ⇒ Object

Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation.



24
25
26
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 24

def ship_method
  @ship_method
end

#ship_method_name ⇒ Object

Shipping method name for internal reference.



27
28
29
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 27

def ship_method_name
  @ship_method_name
end

#tracking_number ⇒ Object

Package tracking identifier from the shipping carrier.



21
22
23
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 21

def tracking_number
  @tracking_number
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 33

def self.attribute_map
  {
    :'package_identifier' => :'packageIdentifier',
    :'tracking_number' => :'trackingNumber',
    :'ship_method' => :'shipMethod',
    :'ship_method_name' => :'shipMethodName',
    :'content' => :'content'
  }
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



141
142
143
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 141

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



55
56
57
58
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 55

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

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 44

def self.openapi_types
  {
    :'package_identifier' => :'Object',
    :'tracking_number' => :'Object',
    :'ship_method' => :'Object',
    :'ship_method_name' => :'Object',
    :'content' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



116
117
118
119
120
121
122
123
124
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      package_identifier == o.package_identifier &&
      tracking_number == o.tracking_number &&
      ship_method == o.ship_method &&
      ship_method_name == o.ship_method_name &&
      content == o.content
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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 171

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::VendorDirectFulfillmentShippingApiModel.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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 240

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 148

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 128

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



134
135
136
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 134

def hash
  [package_identifier, tracking_number, ship_method, ship_method_name, content].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



98
99
100
101
102
103
104
105
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 98

def list_invalid_properties
  invalid_properties = Array.new
  if @content.nil?
    invalid_properties.push('invalid value for "content", content cannot be nil.')
  end

  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



216
217
218
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 216

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



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 222

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



210
211
212
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 210

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



109
110
111
112
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/label_data.rb', line 109

def valid?
  return false if @content.nil?
  true
end