Class: CityPayApiClient::RequestChallenged

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/request_challenged.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestChallenged

Initializes the object



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
95
96
97
98
99
# File 'lib/citypay_api_client/models/request_challenged.rb', line 67

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::RequestChallenged` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::RequestChallenged`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'acs_url')
    self.acs_url = attributes[:'acs_url']
  end

  if attributes.key?(:'creq')
    self.creq = attributes[:'creq']
  end

  if attributes.key?(:'merchantid')
    self.merchantid = attributes[:'merchantid']
  end

  if attributes.key?(:'threedserver_trans_id')
    self.threedserver_trans_id = attributes[:'threedserver_trans_id']
  end

  if attributes.key?(:'transno')
    self.transno = attributes[:'transno']
  end
end

Instance Attribute Details

#acs_urlObject

The url of the Access Control Server (ACS) to forward the user to.



18
19
20
# File 'lib/citypay_api_client/models/request_challenged.rb', line 18

def acs_url
  @acs_url
end

#creqObject

The challenge request data which is encoded for usage by the ACS.



21
22
23
# File 'lib/citypay_api_client/models/request_challenged.rb', line 21

def creq
  @creq
end

#merchantidObject

The merchant id that processed this transaction.



24
25
26
# File 'lib/citypay_api_client/models/request_challenged.rb', line 24

def merchantid
  @merchantid
end

#threedserver_trans_idObject

The 3DSv2 trans id reference for the challenge process. May be used to create the ThreeDSSessionData value to send to the ACS.



27
28
29
# File 'lib/citypay_api_client/models/request_challenged.rb', line 27

def threedserver_trans_id
  @threedserver_trans_id
end

#transnoObject

The transaction number for the challenge, ordered incrementally from 1 for every merchant_id.



30
31
32
# File 'lib/citypay_api_client/models/request_challenged.rb', line 30

def transno
  @transno
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



44
45
46
# File 'lib/citypay_api_client/models/request_challenged.rb', line 44

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



33
34
35
36
37
38
39
40
41
# File 'lib/citypay_api_client/models/request_challenged.rb', line 33

def self.attribute_map
  {
    :'acs_url' => :'acs_url',
    :'creq' => :'creq',
    :'merchantid' => :'merchantid',
    :'threedserver_trans_id' => :'threedserver_trans_id',
    :'transno' => :'transno'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



141
142
143
# File 'lib/citypay_api_client/models/request_challenged.rb', line 141

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



60
61
62
63
# File 'lib/citypay_api_client/models/request_challenged.rb', line 60

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



49
50
51
52
53
54
55
56
57
# File 'lib/citypay_api_client/models/request_challenged.rb', line 49

def self.openapi_types
  {
    :'acs_url' => :'String',
    :'creq' => :'String',
    :'merchantid' => :'Integer',
    :'threedserver_trans_id' => :'String',
    :'transno' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



116
117
118
119
120
121
122
123
124
# File 'lib/citypay_api_client/models/request_challenged.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      acs_url == o.acs_url &&
      creq == o.creq &&
      merchantid == o.merchantid &&
      threedserver_trans_id == o.threedserver_trans_id &&
      transno == o.transno
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
202
203
204
205
206
207
208
209
# File 'lib/citypay_api_client/models/request_challenged.rb', line 172

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  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
    # models (e.g. Pet) or oneOf
    klass = CityPayApiClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/citypay_api_client/models/request_challenged.rb', line 243

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/citypay_api_client/models/request_challenged.rb', line 148

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


128
129
130
# File 'lib/citypay_api_client/models/request_challenged.rb', line 128

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.



134
135
136
# File 'lib/citypay_api_client/models/request_challenged.rb', line 134

def hash
  [acs_url, creq, merchantid, threedserver_trans_id, transno].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?



103
104
105
106
# File 'lib/citypay_api_client/models/request_challenged.rb', line 103

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



219
220
221
# File 'lib/citypay_api_client/models/request_challenged.rb', line 219

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/citypay_api_client/models/request_challenged.rb', line 225

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object



213
214
215
# File 'lib/citypay_api_client/models/request_challenged.rb', line 213

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid



110
111
112
# File 'lib/citypay_api_client/models/request_challenged.rb', line 110

def valid?
  true
end