Class: OpenapiClient::CreateManifestResponseBody

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

Overview

A create manifest response body

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateManifestResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 94

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

  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



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

def carrier_id
  @carrier_id
end

#created_at ⇒ Object

The date-time that the manifest was created



27
28
29
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 27

def created_at
  @created_at
end

#form_id ⇒ Object

A string that uniquely identifies the form



24
25
26
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 24

def form_id
  @form_id
end

#manifest_download ⇒ Object

Returns the value of attribute manifest_download.



44
45
46
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 44

def manifest_download
  @manifest_download
end

#manifest_id ⇒ Object

A string that uniquely identifies the manifest



21
22
23
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 21

def manifest_id
  @manifest_id
end

#manifests ⇒ Object

Returns the value of attribute manifests.



18
19
20
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 18

def manifests
  @manifests
end

#ship_date ⇒ Object

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



30
31
32
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 30

def ship_date
  @ship_date
end

#shipments ⇒ Object

The number of shipments that are included in this manifest



33
34
35
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 33

def shipments
  @shipments
end

#submission_id ⇒ Object

A string that uniquely identifies the submission



39
40
41
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 39

def submission_id
  @submission_id
end

#warehouse_id ⇒ Object

A string that uniquely identifies the warehouse



36
37
38
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 36

def warehouse_id
  @warehouse_id
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 47

def self.attribute_map
  {
    :'manifests' => :'manifests',
    :'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



278
279
280
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 278

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



85
86
87
88
89
90
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 85

def self.openapi_all_of
  [
  :'DeprecatedManifest',
  :'Manifests'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 63

def self.openapi_types
  {
    :'manifests' => :'Array<Manifest>',
    :'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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 248

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 306

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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 375

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



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

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


265
266
267
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 271

def hash
  [manifests, 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



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
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 152

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

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

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

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

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

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

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

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

  if @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

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

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



351
352
353
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 351

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 357

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



345
346
347
 
# File 'lib/openapi_client/models/create_manifest_response_body.rb', line 345

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



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

def valid?
  return false if @manifest_id.nil?
  return false if @form_id.nil?
  return false if @created_at.nil?
  return false if @ship_date.nil?
  return false if @shipments.nil?
  return false if @shipments < 1
  return false if @warehouse_id.nil?
  return false if @submission_id.nil?
  return false if @submission_id.to_s.length < 1
  return false if @carrier_id.nil?
  return false if @manifest_download.nil?
  true
end