Class: ShipEngine::LabelMessages

Inherits:
Object
  • Object
show all
Defined in:
lib/ship_engine/models/label_messages.rb

Overview

Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier. |Carrier |Max lines |Max line length |——————-|———-|——————– |USPS (Stamps.com) |3 |60 |FedEx |3 |35 for the first line. 30 for additional lines. |UPS |2 |35 |OnTrac |2 |25

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LabelMessages

Initializes the object



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ship_engine/models/label_messages.rb', line 56

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

  if attributes.key?(:'reference2')
    self.reference2 = attributes[:'reference2']
  else
    self.reference2 = 'null'
  end

  if attributes.key?(:'reference3')
    self.reference3 = attributes[:'reference3']
  else
    self.reference3 = 'null'
  end
end

Instance Attribute Details

#reference1 ⇒ Object

The first line of the custom label message. Some carriers may prefix this line with something like "REF", "Reference", "Trx Ref No.", etc.



19
20
21
 
# File 'lib/ship_engine/models/label_messages.rb', line 19

def reference1
  @reference1
end

#reference2 ⇒ Object

The second line of the custom label message. Some carriers may prefix this line with something like "INV", "Reference 2", "Trx Ref No.", etc.



22
23
24
 
# File 'lib/ship_engine/models/label_messages.rb', line 22

def reference2
  @reference2
end

#reference3 ⇒ Object

The third line of the custom label message. Some carriers may prefix this line with something like "PO", "Reference 3", etc.



25
26
27
 
# File 'lib/ship_engine/models/label_messages.rb', line 25

def reference3
  @reference3
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/ship_engine/models/label_messages.rb', line 28

def self.attribute_map
  {
    :'reference1' => :'reference1',
    :'reference2' => :'reference2',
    :'reference3' => :'reference3'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



124
125
126
 
# File 'lib/ship_engine/models/label_messages.rb', line 124

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



46
47
48
49
50
51
52
 
# File 'lib/ship_engine/models/label_messages.rb', line 46

def self.openapi_nullable
  Set.new([
    :'reference1',
    :'reference2',
    :'reference3'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
 
# File 'lib/ship_engine/models/label_messages.rb', line 37

def self.openapi_types
  {
    :'reference1' => :'String',
    :'reference2' => :'String',
    :'reference3' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



101
102
103
104
105
106
107
 
# File 'lib/ship_engine/models/label_messages.rb', line 101

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference1 == o.reference1 &&
      reference2 == o.reference2 &&
      reference3 == o.reference3
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/ship_engine/models/label_messages.rb', line 152

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

#_to_hash(value) ⇒ Hash

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



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/ship_engine/models/label_messages.rb', line 221

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/ship_engine/models/label_messages.rb', line 131

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


111
112
113
 
# File 'lib/ship_engine/models/label_messages.rb', line 111

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



117
118
119
 
# File 'lib/ship_engine/models/label_messages.rb', line 117

def hash
  [reference1, reference2, reference3].hash
end

#list_invalid_properties ⇒ Object

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



88
89
90
91
 
# File 'lib/ship_engine/models/label_messages.rb', line 88

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



197
198
199
 
# File 'lib/ship_engine/models/label_messages.rb', line 197

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/ship_engine/models/label_messages.rb', line 203

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



191
192
193
 
# File 'lib/ship_engine/models/label_messages.rb', line 191

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



95
96
97
 
# File 'lib/ship_engine/models/label_messages.rb', line 95

def valid?
  true
end