Class: UltracartClient::OrderEdiDocument

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/order_edi_document.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderEdiDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
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
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#direction ⇒ Object

Direction the document flowed



19
20
21
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 19

def direction
  @direction
end

#doc_dts ⇒ Object

Date/time the document was created/received



22
23
24
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 22

def doc_dts
  @doc_dts
end

#document ⇒ Object

Returns the value of attribute document.



24
25
26
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 24

def document
  @document
end

#document_type_description ⇒ Object

Returns the value of attribute document_type_description.



26
27
28
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 26

def document_type_description
  @document_type_description
end

#document_type_number ⇒ Object

Returns the value of attribute document_type_number.



28
29
30
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 28

def document_type_number
  @document_type_number
end

#external_id ⇒ Object

Returns the value of attribute external_id.



30
31
32
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 30

def external_id
  @external_id
end

#functional_acknowledgement ⇒ Object

Returns the value of attribute functional_acknowledgement.



32
33
34
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 32

def functional_acknowledgement
  @functional_acknowledgement
end

#functional_acknowledgement_dts ⇒ Object

Returns the value of attribute functional_acknowledgement_dts.



34
35
36
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 34

def functional_acknowledgement_dts
  @functional_acknowledgement_dts
end

#functional_acknowledgement_pending ⇒ Object

Returns the value of attribute functional_acknowledgement_pending.



36
37
38
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 36

def functional_acknowledgement_pending
  @functional_acknowledgement_pending
end

#group_control_number ⇒ Object

Returns the value of attribute group_control_number.



38
39
40
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 38

def group_control_number
  @group_control_number
end

#internal_id ⇒ Object

Returns the value of attribute internal_id.



40
41
42
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 40

def internal_id
  @internal_id
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



42
43
44
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 42

def merchant_id
  @merchant_id
end

#order_id ⇒ Object

Returns the value of attribute order_id.



44
45
46
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 44

def order_id
  @order_id
end

#test_mode ⇒ Object

Returns the value of attribute test_mode.



46
47
48
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 46

def test_mode
  @test_mode
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 71

def self.attribute_map
  {
    :'direction' => :'direction',
    :'doc_dts' => :'doc_dts',
    :'document' => :'document',
    :'document_type_description' => :'document_type_description',
    :'document_type_number' => :'document_type_number',
    :'external_id' => :'external_id',
    :'functional_acknowledgement' => :'functional_acknowledgement',
    :'functional_acknowledgement_dts' => :'functional_acknowledgement_dts',
    :'functional_acknowledgement_pending' => :'functional_acknowledgement_pending',
    :'group_control_number' => :'group_control_number',
    :'internal_id' => :'internal_id',
    :'merchant_id' => :'merchant_id',
    :'order_id' => :'order_id',
    :'test_mode' => :'test_mode'
  }
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



254
255
256
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 254

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 96

def self.openapi_types
  {
    :'direction' => :'String',
    :'doc_dts' => :'String',
    :'document' => :'String',
    :'document_type_description' => :'String',
    :'document_type_number' => :'Integer',
    :'external_id' => :'String',
    :'functional_acknowledgement' => :'String',
    :'functional_acknowledgement_dts' => :'String',
    :'functional_acknowledgement_pending' => :'Boolean',
    :'group_control_number' => :'Integer',
    :'internal_id' => :'String',
    :'merchant_id' => :'String',
    :'order_id' => :'String',
    :'test_mode' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      direction == o.direction &&
      doc_dts == o.doc_dts &&
      document == o.document &&
      document_type_description == o.document_type_description &&
      document_type_number == o.document_type_number &&
      external_id == o.external_id &&
      functional_acknowledgement == o.functional_acknowledgement &&
      functional_acknowledgement_dts == o.functional_acknowledgement_dts &&
      functional_acknowledgement_pending == o.functional_acknowledgement_pending &&
      group_control_number == o.group_control_number &&
      internal_id == o.internal_id &&
      merchant_id == o.merchant_id &&
      order_id == o.order_id &&
      test_mode == o.test_mode
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 285

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 356

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 261

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 247

def hash
  [direction, doc_dts, document, document_type_description, document_type_number, external_id, functional_acknowledgement, functional_acknowledgement_dts, functional_acknowledgement_pending, group_control_number, internal_id, merchant_id, order_id, test_mode].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



195
196
197
198
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 195

def list_invalid_properties
  invalid_properties = Array.new
  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



332
333
334
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 332

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 338

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



326
327
328
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 326

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



202
203
204
205
206
 
# File 'lib/ultracart_api/models/order_edi_document.rb', line 202

def valid?
  direction_validator = EnumAttributeValidator.new('String', ["inbound", "outbound"])
  return false unless direction_validator.valid?(@direction)
  true
end