class Bfwd::StripeAuthCaptureRequest
Attributes
{"description":"ID 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":}
{"description":"ID of the captured Card in Stripe. This can be provided as well as — or instead of — the one-use `stripeToken`, to lead BillForward to the card tokenized within the Stripe vault.","verbs":}
{"description":"The 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":}
{"default":false,"description":"Whether 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":}
{"description":"The email address 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":}
{"description":"The first name 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":}
{"description":"The gateway with which your funding instrument has been vaulted.","verbs":}
{"description":"The last name 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":}
{"description":"The 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
— should a BillForward Account
be created by this request.","verbs":}
{"description":"ID of the BillForward Organization
within which the requested PaymentMethod
should be created. If omitted, this will be auto-populated using your authentication credentials.","verbs":}
{"description":"Single-use token <a href=\"provided“>stripe.com/docs/stripe.js\">provided by Stripe's client-side card capture SDK</a>, in response to your capturing a card into the Stripe vault. This token will be used by BillForward to find the tokenized card within the Stripe vault — precursory to linking a BillForward PaymentMethod
to that tokenized card.","verbs":}
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 78 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', :'stripe_token' => :'stripeToken', :'card_id' => :'cardID', :'customer_id' => :'customerID' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 117 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.account_id = 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?(:'stripeToken') self.stripe_token = attributes[:'stripeToken'] end if attributes.has_key?(:'cardID') self.card_id = attributes[:'cardID'] end if attributes.has_key?(:'customerID') self.customer_id = attributes[:'customerID'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 97 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', :'stripe_token' => :'String', :'card_id' => :'String', :'customer_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 228 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && account_id == o.account_id && 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 && stripe_token == o.stripe_token && card_id == o.card_id && customer_id == o.customer_id end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 282 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 348 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 261 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
@see the `==` method @param [Object] Object to be compared
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 248 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] gateway Object to be assigned
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 218 def gateway=(gateway) validator = EnumAttributeValidator.new('String', ["Balanced", "Braintree", "Cybersource", "Paypal", "Stripe", "AuthorizeNet", "Spreedly", "SagePay", "TrustCommerce", "Payvision", "Kash"]) unless validator.valid?(gateway) fail ArgumentError, "invalid value for 'gateway', must be one of #{validator.allowable_values}." end @gateway = gateway end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 254 def hash [type, account_id, gateway, company_name, email, first_name, last_name, mobile, default_payment_method, organization_id, stripe_token, card_id, customer_id].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 181 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push("invalid value for 'type', type cannot be nil.") end if @stripe_token.nil? invalid_properties.push("invalid value for 'stripe_token', stripe_token cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 334 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 322 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 208 def type=(type) validator = EnumAttributeValidator.new('String', ["StripeAuthCaptureRequest"]) unless validator.valid?(type) fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/bf_ruby2/models/stripe_auth_capture_request.rb, line 196 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 @stripe_token.nil? return true end