Class: OpenapiClient::Manifest

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

Overview

Used for combining packages into one scannable form that a carrier can use when picking up a large number of shipments

Direct Known Subclasses

GetManifestByIdResponseBody

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Manifest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/openapi_client/models/manifest.rb', line 82

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#carrier_id ⇒ Object

A string that uniquely identifies the carrier



40
41
42
 
# File 'lib/openapi_client/models/manifest.rb', line 40

def carrier_id
  @carrier_id
end

#created_at ⇒ Object

The date-time that the manifest was created



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

def created_at
  @created_at
end

#form_id ⇒ Object

A string that uniquely identifies the form



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

def form_id
  @form_id
end

#manifest_download ⇒ Object

Returns the value of attribute manifest_download.



42
43
44
 
# File 'lib/openapi_client/models/manifest.rb', line 42

def manifest_download
  @manifest_download
end

#manifest_id ⇒ Object

A string that uniquely identifies the manifest



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

def manifest_id
  @manifest_id
end

#ship_date ⇒ Object

The date-time that the manifests shipments will be picked up



28
29
30
 
# File 'lib/openapi_client/models/manifest.rb', line 28

def ship_date
  @ship_date
end

#shipments ⇒ Object

The number of shipments that are included in this manifest



31
32
33
 
# File 'lib/openapi_client/models/manifest.rb', line 31

def shipments
  @shipments
end

#submission_id ⇒ Object

A string that uniquely identifies the submission



37
38
39
 
# File 'lib/openapi_client/models/manifest.rb', line 37

def submission_id
  @submission_id
end

#warehouse_id ⇒ Object

A string that uniquely identifies the warehouse



34
35
36
 
# File 'lib/openapi_client/models/manifest.rb', line 34

def warehouse_id
  @warehouse_id
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/openapi_client/models/manifest.rb', line 45

def self.attribute_map
  {
    :'manifest_id' => :'manifest_id',
    :'form_id' => :'form_id',
    :'created_at' => :'created_at',
    :'ship_date' => :'ship_date',
    :'shipments' => :'shipments',
    :'warehouse_id' => :'warehouse_id',
    :'submission_id' => :'submission_id',
    :'carrier_id' => :'carrier_id',
    :'manifest_download' => :'manifest_download'
  }
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



206
207
208
 
# File 'lib/openapi_client/models/manifest.rb', line 206

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/openapi_client/models/manifest.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/openapi_client/models/manifest.rb', line 60

def self.openapi_types
  {
    :'manifest_id' => :'String',
    :'form_id' => :'String',
    :'created_at' => :'DateTime',
    :'ship_date' => :'DateTime',
    :'shipments' => :'Integer',
    :'warehouse_id' => :'String',
    :'submission_id' => :'String',
    :'carrier_id' => :'String',
    :'manifest_download' => :'ManifestDownload'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      manifest_id == o.manifest_id &&
      form_id == o.form_id &&
      created_at == o.created_at &&
      ship_date == o.ship_date &&
      shipments == o.shipments &&
      warehouse_id == o.warehouse_id &&
      submission_id == o.submission_id &&
      carrier_id == o.carrier_id &&
      manifest_download == o.manifest_download
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/openapi_client/models/manifest.rb', line 234

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/openapi_client/models/manifest.rb', line 303

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/openapi_client/models/manifest.rb', line 213

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


193
194
195
 
# File 'lib/openapi_client/models/manifest.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



199
200
201
 
# File 'lib/openapi_client/models/manifest.rb', line 199

def hash
  [manifest_id, form_id, created_at, ship_date, shipments, warehouse_id, submission_id, carrier_id, manifest_download].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



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/openapi_client/models/manifest.rb', line 134

def list_invalid_properties
  invalid_properties = Array.new
  if !@shipments.nil? && @shipments < 1
    invalid_properties.push('invalid value for "shipments", must be greater than or equal to 1.')
  end

  if !@submission_id.nil? && @submission_id.to_s.length < 1
    invalid_properties.push('invalid value for "submission_id", the character length must be great than or equal to 1.')
  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



279
280
281
 
# File 'lib/openapi_client/models/manifest.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/openapi_client/models/manifest.rb', line 285

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



273
274
275
 
# File 'lib/openapi_client/models/manifest.rb', line 273

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



149
150
151
152
153
 
# File 'lib/openapi_client/models/manifest.rb', line 149

def valid?
  return false if !@shipments.nil? && @shipments < 1
  return false if !@submission_id.nil? && @submission_id.to_s.length < 1
  true
end