Class: OrbipayPaymentsapiClient::Fee

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/fee.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fee_amount: nil) ⇒ Fee

Returns a new instance of Fee.

Parameters:

  • fee_amount (String) (defaults to: nil) —

    attribute in the form of String.



42
43
44
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 42

def initialize(fee_amount: nil)
    @fee_amount = fee_amount
end

Instance Attribute Details

#fee_amount ⇒ String (readonly)

The fee amount upto 2 decimal places.

Returns:

  • (String) —

    The attribute fee_amount.



10
11
12
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 10

def fee_amount
  @fee_amount
end

#fee_type ⇒ String (readonly)

The way the fee is being charged to the customer. Fee could be added to the amount being paid, or, it could be charged separately by the biller. The fee_type would default to add_to_principal if the fee is not configured for the client in EBPP.

Returns:

  • (String) —

    The attribute fee_type.



6
7
8
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 6

def fee_type
  @fee_type
end

#id ⇒ String (readonly)

The unique identifier assigned by EBPP to the fee. In case of split fee.

Returns:

  • (String) —

    The attribute id.



14
15
16
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 14

def id
  @id
end

#url ⇒ String (readonly)

This URL fetches the details of fee as a payment resource. In case of split fee.

Returns:

  • (String) —

    The attribute url.



18
19
20
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 18

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 22

def self.attribute_map
  {
    :'fee_type' => :'fee_type', 
    :'fee_amount' => :'fee_amount', 
    :'id' => :'id', 
    :'url' => :'url' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 32

def self.swagger_types
  {
    :'fee_type' => :'String',	
    :'fee_amount' => :'String',	
    :'id' => :'String',	
    :'url' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



58
59
60
61
62
63
64
65
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 58

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      fee_type == o.fee_type &&
      fee_amount == o.fee_amount &&
      id == o.id &&
      url == o.url
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (string) —

    Data type

  • value (string) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
150
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 102

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    if value.nil?
      value
    else
      value.to_s
    end
  when :Integer
    if value.nil?
      value
    else
      value.to_i
    end
  when :Float
    if value.nil?
      value
    else
      value.to_f
    end
  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 = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash, Object

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

  • (Object) —

    Returns the object if it cannot be converted to hash



181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 181

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 81

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 the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        set_values(key => attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      set_values(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

Returns:

  • (Boolean)

See Also:

  • `==` method


68
69
70
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 68

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



74
75
76
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 74

def hash
  [fee_type, fee_amount, id, url].hash
end

#set_values(args) ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 49

def set_values(args)
  args.each do |attr, arg|
    (class << self; self; end).send(:attr_reader, attr.to_sym)
    instance_variable_set("@#{attr}", arg)
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 160

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



166
167
168
169
170
171
172
173
174
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 166

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

Returns:

  • (String) —

    String presentation of the object



154
155
156
 
# File 'lib/orbipay_paymentsapi_client/wrappers/fee.rb', line 154

def to_s
  to_hash.to_s
end