Class: Bfwd::BraintreeAuthCaptureRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BraintreeAuthCaptureRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 113

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

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

  if attributes.has_key?(:'deviceData')
    self.device_data = attributes[:'deviceData']
  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/braintree_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 — should a BillForward Account be created by this request.“,”verbs“:



27
28
29
 
# File 'lib/bf_ruby2/models/braintree_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/braintree_auth_capture_request.rb', line 42

def default_payment_method
  @default_payment_method
end

#device_data ⇒ Object

when vaulting a PayPal payment method; otherwise optional)
A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by <a href=\"developers.braintreepayments.com/javascript+node/guides/advanced-fraud-tools/client-side\">braintree-data.js</a> &mdash; if and only if you use Braintree’s drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.“,”verbs“:



51
52
53
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 51

def device_data
  @device_data
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/braintree_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/braintree_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/braintree_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/braintree_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/braintree_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/braintree_auth_capture_request.rb', line 45

def organization_id
  @organization_id
end

#payment_method_nonce ⇒ Object

cryptographic nonce <a href=\"developers.braintreepayments.com/javascript+node/start/overview\">provided by Braintree’s client-side card capture SDK</a>, in response to your capturing a card into the Braintree vault. This nonce will be used by BillForward to find the tokenized card within the Braintree vault &mdash; precursory to linking a BillForward PaymentMethod to that tokenized card“,”verbs“:



48
49
50
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 48

def payment_method_nonce
  @payment_method_nonce
end

#type ⇒ Object

Returns the value of attribute type.



18
19
20
 
# File 'lib/bf_ruby2/models/braintree_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.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 76

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',
    :'payment_method_nonce' => :'paymentMethodNonce',
    :'device_data' => :'deviceData'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 94

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',
    :'payment_method_nonce' => :'String',
    :'device_data' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 220

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 &&
      payment_method_nonce == o.payment_method_nonce &&
      device_data == o.device_data
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 273

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 339

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 252

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


239
240
241
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 245

def hash
  [type, , gateway, company_name, email, first_name, last_name, mobile, default_payment_method, organization_id, payment_method_nonce, device_data].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



173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 173

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

  if @payment_method_nonce.nil?
    invalid_properties.push("invalid value for 'payment_method_nonce', payment_method_nonce 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



319
320
321
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 319

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



325
326
327
328
329
330
331
332
333
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 325

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



313
314
315
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 313

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



188
189
190
191
192
193
194
195
196
 
# File 'lib/bf_ruby2/models/braintree_auth_capture_request.rb', line 188

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 false if @payment_method_nonce.nil?
  return true
end