Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::FeeResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/fee_response.rb

Overview

.

############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FeeResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 62

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?(:'fee_type')
    self.fee_type = attributes[:'fee_type']
  end

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

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

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

Instance Attribute Details

#fee_amount ⇒ String (readonly)

The fee amount upto 2 decimal places.

Returns:

  • (String) —

    The attribute fee_amount.


30
31
32
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 30

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.


26
27
28
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 26

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.


34
35
36
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 34

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.


38
39
40
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 38

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

41
42
43
44
45
46
47
48
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 41

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

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

51
52
53
54
55
56
57
58
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 51

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.

Parameters:

  • o (Object) —

    Object to be compared

[View source]

96
97
98
99
100
101
102
103
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 96

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

[View source]

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
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 141

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

[View source]

220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 220

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

[View source]

120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 120

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

Parameters:

  • o (Object) —

    Object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method
[View source]

107
108
109
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 107

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

113
114
115
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 113

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

#set_values(args) ⇒ Object

[View source]

86
87
88
89
90
91
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 86

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

[View source]

199
200
201
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 199

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

[View source]

205
206
207
208
209
210
211
212
213
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 205

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

[View source]

193
194
195
 
# File 'lib/orbipay_paymentsapi_client/models/fee_response.rb', line 193

def to_s
  to_hash.to_s
end