Class: Bfwd::BraintreeCaptureRequest

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

Overview

Warning: for use only in PCI-compliant environments; for more information, <a href="[email protected]">contact us</a> regarding provisioning of your own on-premise BillForward instance

This entity is for specifying raw credit card details, to be captured into the Braintree vault.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BraintreeCaptureRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
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
152
153
154
155
156
157
158
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 98

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'ipAddressCountry')
    self.ip_address_country = attributes[:'ipAddressCountry']
  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“:



25
26
27
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 25

def 
  @account_id
end

#card_number ⇒ Object

of the credit card being captured.“,”verbs“:



34
35
36
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 34

def card_number
  @card_number
end

#cardholder_name ⇒ Object

of the person who holds the credit card being captured.“,”verbs“:



31
32
33
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 31

def cardholder_name
  @cardholder_name
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 19

def created
  @created
end

#cvv ⇒ Object

or 4 digit card verification value assigned to the credit card being captured.“,”verbs“:



43
44
45
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 43

def cvv
  @cvv
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“:



28
29
30
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 28

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“:



46
47
48
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 46

def device_data
  @device_data
end

#expiry_month ⇒ Object

month of the credit card being captured, formatted MM.“,”verbs“:



37
38
39
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 37

def expiry_month
  @expiry_month
end

#expiry_year ⇒ Object

year of the credit card being captured, formatted YYYY or YY.“,”verbs“:



40
41
42
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 40

def expiry_year
  @expiry_year
end

#ip_address ⇒ Object

address of the customer providing the details of the credit card to be captured.“,”verbs“:



52
53
54
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 52

def ip_address
  @ip_address
end

#ip_address_country ⇒ Object

of the IP address of the customer providing the details of the credit card to be captured.“,”verbs“:



55
56
57
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 55

def ip_address_country
  @ip_address_country
end

#merchant_account_id ⇒ Object

<a href=\"articles.braintreepayments.com/control-panel/important-gateway-credentials\">Merchant account ID</a> with which you wish for the captured funding instrument to transact. Within your Braintree gateway, you can have multiple merchant accounts to process transactions for different businesses or currencies. If you have a single merchant account, it is not necessary to specify a merchant account ID in your API requests. If you have multiple merchant accounts and choose not to specify the merchant account ID, all requests will process through your default merchant account.“,”verbs“:



49
50
51
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 49

def 
  @merchant_account_id
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“:



22
23
24
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 22

def organization_id
  @organization_id
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 59

def self.attribute_map
  {
    :'created' => :'created',
    :'organization_id' => :'organizationID',
    :'account_id' => :'accountID',
    :'default_payment_method' => :'defaultPaymentMethod',
    :'cardholder_name' => :'cardholderName',
    :'card_number' => :'cardNumber',
    :'expiry_month' => :'expiryMonth',
    :'expiry_year' => :'expiryYear',
    :'cvv' => :'cvv',
    :'device_data' => :'deviceData',
    :'merchant_account_id' => :'merchantAccountId',
    :'ip_address' => :'ipAddress',
    :'ip_address_country' => :'ipAddressCountry'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 78

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'organization_id' => :'String',
    :'account_id' => :'String',
    :'default_payment_method' => :'BOOLEAN',
    :'cardholder_name' => :'String',
    :'card_number' => :'String',
    :'expiry_month' => :'String',
    :'expiry_year' => :'String',
    :'cvv' => :'String',
    :'device_data' => :'String',
    :'merchant_account_id' => :'String',
    :'ip_address' => :'String',
    :'ip_address_country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      organization_id == o.organization_id &&
       == o. &&
      default_payment_method == o.default_payment_method &&
      cardholder_name == o.cardholder_name &&
      card_number == o.card_number &&
      expiry_month == o.expiry_month &&
      expiry_year == o.expiry_year &&
      cvv == o.cvv &&
      device_data == o.device_data &&
       == o. &&
      ip_address == o.ip_address &&
      ip_address_country == o.ip_address_country
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



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
285
286
287
288
289
290
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 254

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 320

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 233

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 226

def hash
  [created, organization_id, , default_payment_method, cardholder_name, card_number, expiry_month, expiry_year, cvv, device_data, , ip_address, ip_address_country].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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 162

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

  if @card_number.nil?
    invalid_properties.push("invalid value for 'card_number', card_number cannot be nil.")
  end

  if @expiry_month.nil?
    invalid_properties.push("invalid value for 'expiry_month', expiry_month cannot be nil.")
  end

  if @expiry_year.nil?
    invalid_properties.push("invalid value for 'expiry_year', expiry_year cannot be nil.")
  end

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



300
301
302
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 300

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



306
307
308
309
310
311
312
313
314
 
# File 'lib/bf_ruby2/models/braintree_capture_request.rb', line 306

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



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

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



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

def valid?
  return false if @cardholder_name.nil?
  return false if @card_number.nil?
  return false if @expiry_month.nil?
  return false if @expiry_year.nil?
  return false if @cvv.nil?
  return true
end