Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::ResourceAuditVo

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

Instance Attribute Details

#channel ⇒ String (readonly)

The channel through which the API is invoked. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com</a> to configure channels.

Returns:

  • (String) —

    The attribute channel.



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

def channel
  @channel
end

#requestor ⇒ String (readonly)

The identifier for the requestor of the API, in EBPP. The value to be passed in the requestor field would depend on the requestor_type.</br> If the requestor_type is "customer", the requestor should be the EBPP generated customer id. In the case of self registration, where there is no EBPP generated customer id yet, the requestor should be set to 'guest'.</br> If the requestor_type is "external_user", the requestor can be any unique identifier that the client may have for the external agent. If the requestor_type is system, requestor is optional.

Returns:

  • (String) —

    The attribute requestor.



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

def requestor
  @requestor
end

#requestor_type ⇒ String (readonly)

If an API is being requested from an application that is being used directly by a customer, like the customer portal and IVR, the requestor_type should be set to "customer".</br> If an API is being requested from an application that is being used by third party agents/brokers servicing a customer on behalf of a biller/client, then the requestor_type should be set to "external_user". It should be noted that these users would not have logins for the EBPP Portal or Payment Center.

Returns:

  • (String) —

    The attribute requestor_type.



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

def requestor_type
  @requestor_type
end

#timestamp ⇒ String (readonly)

The UTC timestamp, in ISO8601 format, for the moment when the resource got created or modified in EBPP. For e.g., 2019-08-13T09:21:34.359+0000

Returns:

  • (String) —

    The attribute timestamp.



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

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'channel' => :'channel',
    :'requestor_type' => :'requestor_type',
    :'requestor' => :'requestor',
    :'timestamp' => :'timestamp'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'channel' => :'String',
    :'requestor_type' => :'String',
    :'requestor' => :'String',
    :'timestamp' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channel == o.channel &&
      requestor_type == o.requestor_type &&
      requestor == o.requestor &&
      timestamp == o.timestamp
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



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/resource_audit_vo.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



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/orbipay_paymentsapi_client/models/resource_audit_vo.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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/orbipay_paymentsapi_client/models/resource_audit_vo.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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [channel, requestor_type, requestor, timestamp].hash
end

#set_values(args) ⇒ Object 



86
87
88
89
90
91
 
# File 'lib/orbipay_paymentsapi_client/models/resource_audit_vo.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



199
200
201
 
# File 'lib/orbipay_paymentsapi_client/models/resource_audit_vo.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



205
206
207
208
209
210
211
212
213
 
# File 'lib/orbipay_paymentsapi_client/models/resource_audit_vo.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



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

def to_s
  to_hash.to_s
end