Class: Bfwd::AuthCaptureRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/auth_capture_request.rb

Overview

Note: this request can be built automatically by our client-side card capture library, <a href="github.com/billforward/billforward-js">BillForward.js</a>; you should not need to interact with this API manually unless you have particularly bespoke requirements

This entity is used for requesting that BillForward produce a PaymentMethod, linked to a funding instrument you have vaulted in some payment gateway. The BillForward PaymentMethod will be associated with a BillForward Account of your choosing (or a newly-created Account, if preferred).

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthCaptureRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 103

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#account_id ⇒ Object

of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.“,”verbs“:



21
22
23
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 21

def 
  @account_id
end

#company_name ⇒ Object

name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.“,”verbs“:



27
28
29
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 27

def company_name
  @company_name
end

#default_payment_method ⇒ Object

the PaymentMethod produced by this request should be elected as the ‘default’ payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account’s default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account’s invoices).“,”verbs“:



42
43
44
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 42

def default_payment_method
  @default_payment_method
end

#email ⇒ Object

email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.“,”verbs“:



30
31
32
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 30

def email
  @email
end

#first_name ⇒ Object

first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.“,”verbs“:



33
34
35
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 33

def first_name
  @first_name
end

#gateway ⇒ Object

gateway with which your funding instrument has been vaulted.“,”verbs“:



24
25
26
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 24

def gateway
  @gateway
end

#last_name ⇒ Object

last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.“,”verbs“:



36
37
38
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 36

def last_name
  @last_name
end

#mobile ⇒ Object

mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.“,”verbs“:



39
40
41
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 39

def mobile
  @mobile
end

#organization_id ⇒ Object

of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.“,”verbs“:



45
46
47
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 45

def organization_id
  @organization_id
end

#type ⇒ Object

Returns the value of attribute type.



18
19
20
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 18

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 70

def self.attribute_map
  {
    :'type' => :'@type',
    :'account_id' => :'accountID',
    :'gateway' => :'gateway',
    :'company_name' => :'companyName',
    :'email' => :'email',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'mobile' => :'mobile',
    :'default_payment_method' => :'defaultPaymentMethod',
    :'organization_id' => :'organizationID'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 86

def self.swagger_types
  {
    :'type' => :'String',
    :'account_id' => :'String',
    :'gateway' => :'String',
    :'company_name' => :'String',
    :'email' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'mobile' => :'String',
    :'default_payment_method' => :'BOOLEAN',
    :'organization_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 197

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
       == o. &&
      gateway == o.gateway &&
      company_name == o.company_name &&
      email == o.email &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      mobile == o.mobile &&
      default_payment_method == o.default_payment_method &&
      organization_id == o.organization_id
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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 248

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 = Bfwd.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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 314

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 227

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("#{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 # 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


214
215
216
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



220
221
222
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 220

def hash
  [type, , gateway, company_name, email, first_name, last_name, mobile, default_payment_method, organization_id].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



155
156
157
158
159
160
161
162
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 155

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

  return 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



294
295
296
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 294

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



300
301
302
303
304
305
306
307
308
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 300

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



288
289
290
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 288

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



166
167
168
169
170
171
172
173
 
# File 'lib/bf_ruby2/models/auth_capture_request.rb', line 166

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["StripeAuthCaptureRequest"])
  return false unless type_validator.valid?(@type)
  gateway_validator = EnumAttributeValidator.new('String', ["Balanced", "Braintree", "Cybersource", "Paypal", "Stripe", "AuthorizeNet", "Spreedly", "SagePay", "TrustCommerce", "Payvision", "Kash"])
  return false unless gateway_validator.valid?(@gateway)
  return true
end