Class: UltracartClient::OrderRefundableResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderRefundableResponse

Initializes the object



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key

  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'error')
    self.error = attributes[:'error']
  end

  if attributes.has_key?(:'item_level_refund_reason_required')
    self.item_level_refund_reason_required = attributes[:'item_level_refund_reason_required']
  end

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

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

  if attributes.has_key?(:'manual_because_multiple_charges')
    self.manual_because_multiple_charges = attributes[:'manual_because_multiple_charges']
  end

  if attributes.has_key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

  if attributes.has_key?(:'order_level_refund_reason_required')
    self.order_level_refund_reason_required = attributes[:'order_level_refund_reason_required']
  end

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

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

  if attributes.has_key?(:'refundable')
    self.refundable = attributes[:'refundable']
  end

  if attributes.has_key?(:'success')
    self.success = attributes[:'success']
  end

  if attributes.has_key?(:'warning')
    self.warning = attributes[:'warning']
  end
end

Instance Attribute Details

#error ⇒ Object

Returns the value of attribute error.



17
18
19
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 17

def error
  @error
end

#item_level_refund_reason_required ⇒ Object

True if the item level refund reason is required



20
21
22
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 20

def item_level_refund_reason_required
  @item_level_refund_reason_required
end

#item_level_refund_reasons ⇒ Object

Reason codes available at the item level.



23
24
25
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 23

def item_level_refund_reasons
  @item_level_refund_reasons
end

#item_level_return_reasons ⇒ Object

Return codes available at the item level.



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

def item_level_return_reasons
  @item_level_return_reasons
end

#manual_because_multiple_charges ⇒ Object

If true, this refund will have to be manually done because of additional charges with the virtual terminal were made



29
30
31
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 29

def manual_because_multiple_charges
  @manual_because_multiple_charges
end

#metadata ⇒ Object

Returns the value of attribute metadata.



31
32
33
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 31

def metadata
  @metadata
end

#order_level_refund_reason_required ⇒ Object

True if the order level refund reason is required



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

def order_level_refund_reason_required
  @order_level_refund_reason_required
end

#order_level_refund_reasons ⇒ Object

Reason codes available at the order level.



37
38
39
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 37

def order_level_refund_reasons
  @order_level_refund_reasons
end

#order_level_reject_reasons ⇒ Object

Reject codes available at the order level.



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

def order_level_reject_reasons
  @order_level_reject_reasons
end

#refundable ⇒ Object

Whether the order is refundable or not. Null should be interpreted as false.



43
44
45
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 43

def refundable
  @refundable
end

#success ⇒ Object

Indicates if API call was successful



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

def success
  @success
end

#warning ⇒ Object

Returns the value of attribute warning.



48
49
50
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 48

def warning
  @warning
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 51

def self.attribute_map
  {
    :'error' => :'error',
    :'item_level_refund_reason_required' => :'item_level_refund_reason_required',
    :'item_level_refund_reasons' => :'item_level_refund_reasons',
    :'item_level_return_reasons' => :'item_level_return_reasons',
    :'manual_because_multiple_charges' => :'manual_because_multiple_charges',
    :'metadata' => :'metadata',
    :'order_level_refund_reason_required' => :'order_level_refund_reason_required',
    :'order_level_refund_reasons' => :'order_level_refund_reasons',
    :'order_level_reject_reasons' => :'order_level_reject_reasons',
    :'refundable' => :'refundable',
    :'success' => :'success',
    :'warning' => :'warning'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 69

def self.swagger_types
  {
    :'error' => :'Error',
    :'item_level_refund_reason_required' => :'BOOLEAN',
    :'item_level_refund_reasons' => :'Array<OrderReason>',
    :'item_level_return_reasons' => :'Array<OrderReason>',
    :'manual_because_multiple_charges' => :'BOOLEAN',
    :'metadata' => :'ResponseMetadata',
    :'order_level_refund_reason_required' => :'BOOLEAN',
    :'order_level_refund_reasons' => :'Array<OrderReason>',
    :'order_level_reject_reasons' => :'Array<OrderReason>',
    :'refundable' => :'BOOLEAN',
    :'success' => :'BOOLEAN',
    :'warning' => :'Warning'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error == o.error &&
      item_level_refund_reason_required == o.item_level_refund_reason_required &&
      item_level_refund_reasons == o.item_level_refund_reasons &&
      item_level_return_reasons == o.item_level_return_reasons &&
      manual_because_multiple_charges == o.manual_because_multiple_charges &&
      metadata == o.metadata &&
      order_level_refund_reason_required == o.order_level_refund_reason_required &&
      order_level_refund_reasons == o.order_level_refund_reasons &&
      order_level_reject_reasons == o.order_level_reject_reasons &&
      refundable == o.refundable &&
      success == o.success &&
      warning == o.warning
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 219

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

    temp_model = UltracartClient.const_get(type).new
    temp_model.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



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

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 198

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


185
186
187
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



191
192
193
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 191

def hash
  [error, item_level_refund_reason_required, item_level_refund_reasons, item_level_return_reasons, manual_because_multiple_charges, metadata, order_level_refund_reason_required, order_level_refund_reasons, order_level_reject_reasons, refundable, success, warning].hash
end

#list_invalid_properties ⇒ Object

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



153
154
155
156
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



265
266
267
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 265

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 271

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



259
260
261
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 259

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



160
161
162
 
# File 'lib/ultracart_api/models/order_refundable_response.rb', line 160

def valid?
  true
end