Class: OrbipayPaymentsapiClient::ResourceAudit

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ResourceAudit

Returns a new instance of ResourceAudit.



41
42
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 41

def initialize
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.



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

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.



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

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.



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

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.



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

def timestamp
  @timestamp
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/resource_audit.rb', line 22

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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.



56
57
58
59
60
61
62
63
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 56

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



100
101
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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 100

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



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 179

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



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

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


66
67
68
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 66

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



72
73
74
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 72

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

#set_values(args) ⇒ Object 



47
48
49
50
51
52
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 47

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



158
159
160
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 158

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



164
165
166
167
168
169
170
171
172
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 164

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



152
153
154
 
# File 'lib/orbipay_paymentsapi_client/wrappers/resource_audit.rb', line 152

def to_s
  to_hash.to_s
end