Class: CyberSource::Ptsv2billingagreementsProcessingInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2billingagreementsProcessingInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 49

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

  if attributes.has_key?(:'actionList')
    if (value = attributes[:'actionList']).is_a?(Array)
      self.action_list = value
    end
  end
end

Instance Attribute Details

#action_list ⇒ Object

  • Use ‘CONSUMER_AUTHENTICATION` to use Payer Authentication along with Decision Manager. For any other value, only Decision Manager will run. - Use `WATCHLIST_SCREENING` when you want to call Watchlist Screening service. - Use `UPDATE_AGREEMENT` - Use `BILLING_AGREEMENT_CREATE` - Use `CANCEL_AGREEMENT`



21
22
23
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 21

def action_list
  @action_list
end

#commerce_indicator ⇒ Object

Type of transaction. Used to determine fees based on channel. Possible values: - aesk: American Express SafeKey authentication was successful. - aesk_attempted: American Express SafeKey authentication was attempted but did not succeed. • install: Installment payment. - install_internet: Non-U.S. e-commerce (Internet) installment payment. This value is supported only on Visa Platform Connect. - internet (default for authorizations): E-commerce order placed using a web site. - js: JCB J/Secure authentication was successful. - js_attempted: JCB J/Secure authentication was attempted but did not succeed. - moto: Mail order or telephone order. - moto_cc: Mail order or telephone order from a call center. This value is supported only on the Asia, Middle East, and Africa Gateway. - pb: ProtectBuy authentication was successful. - pb_attempted: ProtectBuy authentication was attempted but did not succeed. - recurring: Recurring payment that is a U.S. transaction or non-U.S. mail order / telephone order (MOTO) transaction. - recurring_internet: Recurring payment that is a non-U.S. e-commerce (Internet) transaction. - retail: Card-present transaction. - spa: For Mastercard Identity Check: Authentication was successful or was attempted but did not succeed. The e-commerce indicator for all Mastercard Identity Check transactions, including authentication attempts, must be set to spa. - spa_attempted: Authentication for a co-badged Mastercard and Cartes Bancaires card was attempted but did not succeed. - spa_failure: – For Mastercard Identity Check: Authentication failed. This value is supported only on Elavon, HSBC, and Streamline. - vbv: – For Visa Secure: Authentication was successful. - vbv_attempted: – For Visa Secure: Authentication was attempted but did not succeed. - vbv_failure: – For Visa Secure: Authentication failed. This value is supported only on HSBC and Streamline.



18
19
20
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 18

def commerce_indicator
  @commerce_indicator
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 24

def self.attribute_map
  {
    :'commerce_indicator' => :'commerceIndicator',
    :'action_list' => :'actionList'
  }
end

.json_map ⇒ Object

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



32
33
34
35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 32

def self.json_map
  {
    :'commerce_indicator' => :'commerce_indicator',
    :'action_list' => :'action_list'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 40

def self.swagger_types
  {
    :'commerce_indicator' => :'String',
    :'action_list' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



87
88
89
90
91
92
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 87

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commerce_indicator == o.commerce_indicator &&
      action_list == o.action_list
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



130
131
132
133
134
135
136
137
138
139
140
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
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 130

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CyberSource.const_get(type).new
    temp_model.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 196

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 109

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)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


96
97
98
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 96

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



102
103
104
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 102

def hash
  [commerce_indicator, action_list].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



68
69
70
71
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 68

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



176
177
178
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 176

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



182
183
184
185
186
187
188
189
190
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 182

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



170
171
172
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 170

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



75
76
77
 
# File 'lib/cybersource_rest_client/models/ptsv2billingagreements_processing_information.rb', line 75

def valid?
  true
end