Class: OCI::OspGateway::Models::PaymentDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/osp_gateway/models/payment_detail.rb

Overview

Payment related details This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

PAYMENT_METHOD_ENUM = 
[
  PAYMENT_METHOD_CREDIT_CARD = 'CREDIT_CARD'.freeze,
  PAYMENT_METHOD_PAYPAL = 'PAYPAL'.freeze,
  PAYMENT_METHOD_ECHECK = 'ECHECK'.freeze,
  PAYMENT_METHOD_OTHER = 'OTHER'.freeze,
  PAYMENT_METHOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_paid_on (DateTime) —

    The value to assign to the #time_paid_on property

  • :paid_by (String) —

    The value to assign to the #paid_by property

  • :payment_method (String) —

    The value to assign to the #payment_method property

  • :amount_paid (Float) —

    The value to assign to the #amount_paid property

[View source]

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
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 89

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 }

  self.time_paid_on = attributes[:'timePaidOn'] if attributes[:'timePaidOn']

  raise 'You cannot provide both :timePaidOn and :time_paid_on' if attributes.key?(:'timePaidOn') && attributes.key?(:'time_paid_on')

  self.time_paid_on = attributes[:'time_paid_on'] if attributes[:'time_paid_on']

  self.paid_by = attributes[:'paidBy'] if attributes[:'paidBy']

  raise 'You cannot provide both :paidBy and :paid_by' if attributes.key?(:'paidBy') && attributes.key?(:'paid_by')

  self.paid_by = attributes[:'paid_by'] if attributes[:'paid_by']

  self.payment_method = attributes[:'paymentMethod'] if attributes[:'paymentMethod']

  raise 'You cannot provide both :paymentMethod and :payment_method' if attributes.key?(:'paymentMethod') && attributes.key?(:'payment_method')

  self.payment_method = attributes[:'payment_method'] if attributes[:'payment_method']

  self.amount_paid = attributes[:'amountPaid'] if attributes[:'amountPaid']

  raise 'You cannot provide both :amountPaid and :amount_paid' if attributes.key?(:'amountPaid') && attributes.key?(:'amount_paid')

  self.amount_paid = attributes[:'amount_paid'] if attributes[:'amount_paid']
end

Instance Attribute Details

#amount_paid ⇒ Float

Amount that paid

Returns:

  • (Float) 

35
36
37
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 35

def amount_paid
  @amount_paid
end

example

Returns:

  • (String) 

27
28
29
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 27

def paid_by
  @paid_by
end

#payment_method ⇒ String

[Required] Payment method

Returns:

  • (String) 

31
32
33
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 31

def payment_method
  @payment_method
end

#time_paid_on ⇒ DateTime

Paid the invoice on this day

Returns:

  • (DateTime) 

23
24
25
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 23

def time_paid_on
  @time_paid_on
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_paid_on': :'timePaidOn',
    'paid_by': :'paidBy',
    'payment_method': :'paymentMethod',
    'amount_paid': :'amountPaid'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

[View source]

66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 66

def self.get_subtype(object_hash)
  type = object_hash[:'paymentMethod'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::OspGateway::Models::EcheckPaymentDetail' if type == 'ECHECK'
  return 'OCI::OspGateway::Models::OtherPaymentDetail' if type == 'OTHER'
  return 'OCI::OspGateway::Models::PaypalPaymentDetail' if type == 'PAYPAL'
  return 'OCI::OspGateway::Models::CreditCardPaymentDetail' if type == 'CREDIT_CARD'

  # TODO: Log a warning when the subtype is not found.
  'OCI::OspGateway::Models::PaymentDetail'
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_paid_on': :'DateTime',
    'paid_by': :'String',
    'payment_method': :'String',
    'amount_paid': :'Float'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared

[View source]

140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 140

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

  self.class == other.class &&
    time_paid_on == other.time_paid_on &&
    paid_by == other.paid_by &&
    payment_method == other.payment_method &&
    amount_paid == other.amount_paid
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

[View source]

173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 173

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

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method
[View source]

153
154
155
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

162
163
164
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 162

def hash
  [time_paid_on, paid_by, payment_method, amount_paid].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 206

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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

[View source]

200
201
202
 
# File 'lib/oci/osp_gateway/models/payment_detail.rb', line 200

def to_s
  to_hash.to_s
end