Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::CreateRefundRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/create_refund_request.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 = {}) ⇒ CreateRefundRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 67

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

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

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

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

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

Instance Attribute Details

#comments ⇒ String (readonly)

Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (EBPP) is not responsible for the security of any sensitive information that may be passed as part of the memo.

Returns:

  • (String) —

    The attribute comments.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 37

def comments
  @comments
end

#custom_fields ⇒ Hash<String, String> (readonly)

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client. The custom fields need to be configured with EBPP before they can be accepted. EBPP would reject custom fields that are not pre-configured. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com</a> for more information on configuring and using custom fields. Only the custom fields enabled for the client, in EBPP, would be accepted in the requests.

Returns:

  • (Hash<String, String>) —

    The attribute custom_fields.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 41

def custom_fields
  @custom_fields
end

#fee_refund ⇒ FeeRefundRequest (readonly)

Returns The attribute fee_refund.

Returns:



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 33

def fee_refund
  @fee_refund
end

#refund_amount ⇒ String (readonly)

The refund amount upto 2 decimal places.

Returns:

  • (String) —

    The attribute refund_amount.



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

def refund_amount
  @refund_amount
end

#refund_reference ⇒ String (readonly)

The unique identifier in the client system for the refund.

Returns:

  • (String) —

    The attribute refund_reference.



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

def refund_reference
  @refund_reference
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 44

def self.attribute_map
  {
    :'refund_reference' => :'refund_reference',
    :'refund_amount' => :'refund_amount',
    :'fee_refund' => :'fee_refund',
    :'comments' => :'comments',
    :'custom_fields' => :'custom_fields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 55

def self.swagger_types
  {
    :'refund_reference' => :'String',
    :'refund_amount' => :'String',
    :'fee_refund' => :'FeeRefundRequest',
    :'comments' => :'String',
    :'custom_fields' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



107
108
109
110
111
112
113
114
115
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      refund_reference == o.refund_reference &&
      refund_amount == o.refund_amount &&
      fee_refund == o.fee_refund &&
      comments == o.comments &&
      custom_fields == o.custom_fields
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



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
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 153

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



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 232

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 132

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


119
120
121
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 119

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



125
126
127
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 125

def hash
  [refund_reference, refund_amount, fee_refund, comments, custom_fields].hash
end

#set_values(args) ⇒ Object 



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

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



211
212
213
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 211

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



217
218
219
220
221
222
223
224
225
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 217

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



205
206
207
 
# File 'lib/orbipay_paymentsapi_client/models/create_refund_request.rb', line 205

def to_s
  to_hash.to_s
end