Class: OpenapiClient::ParseShipmentResponseBody

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/parse_shipment_response_body.rb

Overview

The parsed shipment, as well as a confidence score and a list of all the shipping entities that were recognized in the text.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ParseShipmentResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 53

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

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

  if attributes.key?(:'entities')
    if (value = attributes[:'entities']).is_a?(Array)
      self.entities = value
    end
  end
end

Instance Attribute Details

#entities ⇒ Object

All of the entities that were recognized in the text. An "entity" is a single piece of data, such as a city, a postal code, a carrier name, or a package weight. Each entity includes the original text and the parsed value.



25
26
27
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 25

def entities
  @entities
end

#score ⇒ Object

A confidence score between zero and one that indicates how certain the API is that it understood the text.



19
20
21
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 19

def score
  @score
end

#shipment ⇒ Object

The parsed shipment. This shipment may not be complete, depending on how much information was included in the text and how confident the API is about each recognized entity. > Note: The shipment-recognition API does not currently perform any validation of the parsed addresses, so we recommend that you use the [address-validation API](www.shipengine.com/docs/addresses/validation/) to ensure that the addresses are correct.



22
23
24
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 22

def shipment
  @shipment
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/openapi_client/models/parse_shipment_response_body.rb', line 28

def self.attribute_map
  {
    :'score' => :'score',
    :'shipment' => :'shipment',
    :'entities' => :'entities'
  }
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



162
163
164
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 162

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
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 46

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'score' => :'Float',
    :'shipment' => :'PartialShipment',
    :'entities' => :'Array<RecognizedEntity>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      score == o.score &&
      shipment == o.shipment &&
      entities == o.entities
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 190

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
    OpenapiClient.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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 259

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 169

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 155

def hash
  [score, shipment, entities].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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 83

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

  if @score > 1
    invalid_properties.push('invalid value for "score", must be smaller than or equal to 1.')
  end

  if @score < 0
    invalid_properties.push('invalid value for "score", must be greater than or equal to 0.')
  end

  if @shipment.nil?
    invalid_properties.push('invalid value for "shipment", shipment cannot be nil.')
  end

  if @entities.nil?
    invalid_properties.push('invalid value for "entities", entities 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



235
236
237
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 235

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 241

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



229
230
231
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 229

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



110
111
112
113
114
115
116
117
 
# File 'lib/openapi_client/models/parse_shipment_response_body.rb', line 110

def valid?
  return false if @score.nil?
  return false if @score > 1
  return false if @score < 0
  return false if @shipment.nil?
  return false if @entities.nil?
  true
end