Class: Api::ChargeResult

Inherits:
Object
  • Object
show all
Defined in:
lib/jamm/api/models/v1_charge_result.rb

Overview

Contains the result of a charge operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChargeResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError)


81
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
# File 'lib/jamm/api/models/v1_charge_result.rb', line 81

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `Api::ChargeResult` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `Api::ChargeResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.charge_id = attributes[:charge_id] if attributes.key?(:charge_id)

  self.paid = attributes[:paid] if attributes.key?(:paid)

  self.reason = attributes[:reason] if attributes.key?(:reason)

  self.description = attributes[:description] if attributes.key?(:description)

  self.merchant_name = attributes[:merchant_name] if attributes.key?(:merchant_name)

  self.initial_amount = attributes[:initial_amount] if attributes.key?(:initial_amount)

  self.discount = attributes[:discount] if attributes.key?(:discount)

  self.final_amount = attributes[:final_amount] if attributes.key?(:final_amount)

  self.amount_refunded = attributes[:amount_refunded] if attributes.key?(:amount_refunded)

  self.currency = attributes[:currency] if attributes.key?(:currency)

  self.token_id = attributes[:token_id] if attributes.key?(:token_id)

  if attributes.key?(:metadata) && (value = attributes[:metadata]).is_a?(Hash)
    self. = value
  end

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

  self.updated_at = attributes[:updated_at] if attributes.key?(:updated_at)

  return unless attributes.key?(:processed_at)

  self.processed_at = attributes[:processed_at]
end

Instance Attribute Details

#amount_refundedObject

Returns the value of attribute amount_refunded.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def amount_refunded
  @amount_refunded
end

#charge_idObject

Returns the value of attribute charge_id.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def charge_id
  @charge_id
end

#created_atObject

Returns the value of attribute created_at.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def created_at
  @created_at
end

#currencyObject

Returns the value of attribute currency.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def currency
  @currency
end

#descriptionObject

Returns the value of attribute description.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def description
  @description
end

#discountObject

Returns the value of attribute discount.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def discount
  @discount
end

#final_amountObject

Returns the value of attribute final_amount.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def final_amount
  @final_amount
end

#initial_amountObject

Returns the value of attribute initial_amount.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def initial_amount
  @initial_amount
end

#merchant_nameObject

Returns the value of attribute merchant_name.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def merchant_name
  @merchant_name
end

#metadataObject

Returns the value of attribute metadata.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def 
  @metadata
end

True when charged.



22
23
24
# File 'lib/jamm/api/models/v1_charge_result.rb', line 22

def paid
  @paid
end

#processed_atObject

Returns the value of attribute processed_at.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def processed_at
  @processed_at
end

#reasonObject

Reason contains enum status in string. Merchant should not write any code depending on the reason, because Jamm may update the reason at any time.



25
26
27
# File 'lib/jamm/api/models/v1_charge_result.rb', line 25

def reason
  @reason
end

#token_idObject

Returns the value of attribute token_id.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def token_id
  @token_id
end

#updated_atObject

Returns the value of attribute updated_at.



19
20
21
# File 'lib/jamm/api/models/v1_charge_result.rb', line 19

def updated_at
  @updated_at
end

Class Method Details

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



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
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/jamm/api/models/v1_charge_result.rb', line 201

def self._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 = Api.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



49
50
51
# File 'lib/jamm/api/models/v1_charge_result.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/jamm/api/models/v1_charge_result.rb', line 28

def self.attribute_map
  {
    :charge_id => :chargeId,
    :paid => :paid,
    :reason => :reason,
    :description => :description,
    :merchant_name => :merchantName,
    :initial_amount => :initialAmount,
    :discount => :discount,
    :final_amount => :finalAmount,
    :amount_refunded => :amountRefunded,
    :currency => :currency,
    :token_id => :tokenId,
    :metadata => :metadata,
    :created_at => :createdAt,
    :updated_at => :updatedAt,
    :processed_at => :processedAt
  }
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/jamm/api/models/v1_charge_result.rb', line 178

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = 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
      transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) } if attributes[attribute_map[key]].is_a?(Array)
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



75
76
77
# File 'lib/jamm/api/models/v1_charge_result.rb', line 75

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

.openapi_typesObject

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/jamm/api/models/v1_charge_result.rb', line 54

def self.openapi_types
  {
    :charge_id => :String,
    :paid => :Boolean,
    :reason => :String,
    :description => :String,
    :merchant_name => :String,
    :initial_amount => :Integer,
    :discount => :Integer,
    :final_amount => :Integer,
    :amount_refunded => :Integer,
    :currency => :String,
    :token_id => :String,
    :metadata => :'Hash<String, String>',
    :created_at => :Time,
    :updated_at => :Time,
    :processed_at => :Time
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/jamm/api/models/v1_charge_result.rb', line 142

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    charge_id == other.charge_id &&
    paid == other.paid &&
    reason == other.reason &&
    description == other.description &&
    merchant_name == other.merchant_name &&
    initial_amount == other.initial_amount &&
    discount == other.discount &&
    final_amount == other.final_amount &&
    amount_refunded == other.amount_refunded &&
    currency == other.currency &&
    token_id == other.token_id &&
     == other. &&
    created_at == other.created_at &&
    updated_at == other.updated_at &&
    processed_at == other.processed_at
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



272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'lib/jamm/api/models/v1_charge_result.rb', line 272

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
# File 'lib/jamm/api/models/v1_charge_result.rb', line 165

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



171
172
173
# File 'lib/jamm/api/models/v1_charge_result.rb', line 171

def hash
  [charge_id, paid, reason, description, merchant_name, initial_amount, discount, final_amount, amount_refunded, currency, token_id, , created_at, updated_at, processed_at].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



128
129
130
131
# File 'lib/jamm/api/models/v1_charge_result.rb', line 128

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  []
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



248
249
250
# File 'lib/jamm/api/models/v1_charge_result.rb', line 248

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/jamm/api/models/v1_charge_result.rb', line 254

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



242
243
244
# File 'lib/jamm/api/models/v1_charge_result.rb', line 242

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



135
136
137
138
# File 'lib/jamm/api/models/v1_charge_result.rb', line 135

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end