Class: CyberSource::ECheckConfigCommonProcessors

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

Overview

Payment Processing connection used to support eCheck, aka ACH, payment methods. Example - "bofaach"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ECheckConfigCommonProcessors

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
100
101
102
103
104
105
106
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 73

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

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

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

  if attributes.has_key?(:'enableAccuityForAvs')
    self.enable_accuity_for_avs = attributes[:'enableAccuityForAvs']
  else
    self.enable_accuity_for_avs = true
  end

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

  if attributes.has_key?(:'setCompletedState')
    self.set_completed_state = attributes[:'setCompletedState']
  else
    self.set_completed_state = false
  end
end

Instance Attribute Details

#accuity_check_type ⇒ Object

NEW



30
31
32
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 30

def accuity_check_type
  @accuity_check_type
end

#batch_group ⇒ Object

EXISTING Capture requests are grouped into a batch bound for your payment processor. The batch time can be identified by reading the last 2-digits as military time. E.g., <processor>_16 = your processing cutoff is 4PM PST. Please note if you are in a different location you may then need to convert time zone as well.



24
25
26
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 24

def batch_group
  @batch_group
end

#company_entry_description ⇒ Object

EXISTING Company (merchant) defined description of entry to receive. For e.g. PAYROLL, GAS BILL, INS PREM. This field is alphanumeric



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

def company_entry_description
  @company_entry_description
end

#company_id ⇒ Object

EXISTING company ID assigned to merchant by Acquiring bank. This field is alphanumeric



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

def company_id
  @company_id
end

#enable_accuity_for_avs ⇒ Object

NEW Accuity is the original validation service that checks the account/routing number for formatting issues. Used by WF and set to "Yes" unless told otherwise



27
28
29
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 27

def enable_accuity_for_avs
  @enable_accuity_for_avs
end

#set_completed_state ⇒ Object

Moved When set to Yes we will automatically update transactions to a completed status X-number of days after the transaction comes through; if no failure notification is received. When set to No means we will not update transaction status in this manner. For BAMS/Bank of America merchants, they should be set to No unless we are explicitly asked to set a merchant to YES.



33
34
35
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 33

def set_completed_state
  @set_completed_state
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 36

def self.attribute_map
  {
    :'company_entry_description' => :'companyEntryDescription',
    :'company_id' => :'companyId',
    :'batch_group' => :'batchGroup',
    :'enable_accuity_for_avs' => :'enableAccuityForAvs',
    :'accuity_check_type' => :'accuityCheckType',
    :'set_completed_state' => :'setCompletedState'
  }
end

.json_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 48

def self.json_map
  {
    :'company_entry_description' => :'company_entry_description',
    :'company_id' => :'company_id',
    :'batch_group' => :'batch_group',
    :'enable_accuity_for_avs' => :'enable_accuity_for_avs',
    :'accuity_check_type' => :'accuity_check_type',
    :'set_completed_state' => :'set_completed_state'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 60

def self.swagger_types
  {
    :'company_entry_description' => :'String',
    :'company_id' => :'String',
    :'batch_group' => :'String',
    :'enable_accuity_for_avs' => :'BOOLEAN',
    :'accuity_check_type' => :'Object',
    :'set_completed_state' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company_entry_description == o.company_entry_description &&
      company_id == o.company_id &&
      batch_group == o.batch_group &&
      enable_accuity_for_avs == o.enable_accuity_for_avs &&
      accuity_check_type == o.accuity_check_type &&
      set_completed_state == o.set_completed_state
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 191

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 257

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 170

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


157
158
159
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 163

def hash
  [company_entry_description, company_id, batch_group, enable_accuity_for_avs, accuity_check_type, set_completed_state].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



110
111
112
113
114
115
116
117
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 110

def list_invalid_properties
  invalid_properties = Array.new
  if @company_entry_description.nil?
    invalid_properties.push('invalid value for "company_entry_description", company_entry_description cannot be nil.')
  end

  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



237
238
239
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 237

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 243

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



231
232
233
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 231

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



121
122
123
124
 
# File 'lib/cybersource_rest_client/models/e_check_config_common_processors.rb', line 121

def valid?
  return false if @company_entry_description.nil?
  true
end