class Wallee::TransactionCreate
Attributes
When auto confirmation is enabled the transaction can be confirmed by the user and does not require an explicit confirmation through the web service API.
When the charging of the customer fails we can retry the charging. This implies that we redirect the user back to the payment page which allows the customer to retry. By default we will retry.
The completion behavior controls when the transaction is completed.
The customer email address is the email address of the customer. If no email address is provided on the shipping or billing address this address is used.
The customer's presence indicates what kind of authentication methods can be used during the authorization of the transaction. If no value is provided, 'Virtually Present' is used by default.
The device session identifier links the transaction with the session identifier provided in the URL of the device data JavaScript. This allows to link the transaction with the collected device data of the buyer.
Flag indicating whether email sending is disabled for this particular transaction. Defaults to false.
The environment selection strategy determines how the environment (test or production) for processing the transaction is selected.
The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.
Meta data allow to store additional data along the object.
The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.
The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
The tokenization mode controls if and how the tokenization of payment information is applied to the transaction.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 105 def self.attribute_map { :'allowed_payment_method_brands' => :'allowedPaymentMethodBrands', :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations', :'billing_address' => :'billingAddress', :'completion_behavior' => :'completionBehavior', :'currency' => :'currency', :'customer_email_address' => :'customerEmailAddress', :'customer_id' => :'customerId', :'failed_url' => :'failedUrl', :'invoice_merchant_reference' => :'invoiceMerchantReference', :'language' => :'language', :'line_items' => :'lineItems', :'merchant_reference' => :'merchantReference', :'meta_data' => :'metaData', :'shipping_address' => :'shippingAddress', :'shipping_method' => :'shippingMethod', :'success_url' => :'successUrl', :'time_zone' => :'timeZone', :'token' => :'token', :'tokenization_mode' => :'tokenizationMode', :'auto_confirmation_enabled' => :'autoConfirmationEnabled', :'charge_retry_enabled' => :'chargeRetryEnabled', :'customers_presence' => :'customersPresence', :'device_session_identifier' => :'deviceSessionIdentifier', :'emails_disabled' => :'emailsDisabled', :'environment' => :'environment', :'environment_selection_strategy' => :'environmentSelectionStrategy', :'space_view_id' => :'spaceViewId' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 172 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?(:'allowedPaymentMethodBrands') if (value = attributes[:'allowedPaymentMethodBrands']).is_a?(Array) self.allowed_payment_method_brands = value end end if attributes.has_key?(:'allowedPaymentMethodConfigurations') if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array) self.allowed_payment_method_configurations = value end end if attributes.has_key?(:'billingAddress') self.billing_address = attributes[:'billingAddress'] end if attributes.has_key?(:'completionBehavior') self.completion_behavior = attributes[:'completionBehavior'] end if attributes.has_key?(:'currency') self.currency = attributes[:'currency'] end if attributes.has_key?(:'customerEmailAddress') self.customer_email_address = attributes[:'customerEmailAddress'] end if attributes.has_key?(:'customerId') self.customer_id = attributes[:'customerId'] end if attributes.has_key?(:'failedUrl') self.failed_url = attributes[:'failedUrl'] end if attributes.has_key?(:'invoiceMerchantReference') self.invoice_merchant_reference = attributes[:'invoiceMerchantReference'] end if attributes.has_key?(:'language') self.language = attributes[:'language'] end if attributes.has_key?(:'lineItems') if (value = attributes[:'lineItems']).is_a?(Array) self.line_items = value end end if attributes.has_key?(:'merchantReference') self.merchant_reference = attributes[:'merchantReference'] end if attributes.has_key?(:'metaData') if (value = attributes[:'metaData']).is_a?(Hash) self.meta_data = value end end if attributes.has_key?(:'shippingAddress') self.shipping_address = attributes[:'shippingAddress'] end if attributes.has_key?(:'shippingMethod') self.shipping_method = attributes[:'shippingMethod'] end if attributes.has_key?(:'successUrl') self.success_url = attributes[:'successUrl'] end if attributes.has_key?(:'timeZone') self.time_zone = attributes[:'timeZone'] end if attributes.has_key?(:'token') self.token = attributes[:'token'] end if attributes.has_key?(:'tokenizationMode') self.tokenization_mode = attributes[:'tokenizationMode'] end if attributes.has_key?(:'autoConfirmationEnabled') self.auto_confirmation_enabled = attributes[:'autoConfirmationEnabled'] end if attributes.has_key?(:'chargeRetryEnabled') self.charge_retry_enabled = attributes[:'chargeRetryEnabled'] end if attributes.has_key?(:'customersPresence') self.customers_presence = attributes[:'customersPresence'] end if attributes.has_key?(:'deviceSessionIdentifier') self.device_session_identifier = attributes[:'deviceSessionIdentifier'] end if attributes.has_key?(:'emailsDisabled') self.emails_disabled = attributes[:'emailsDisabled'] end if attributes.has_key?(:'environment') self.environment = attributes[:'environment'] end if attributes.has_key?(:'environmentSelectionStrategy') self.environment_selection_strategy = attributes[:'environmentSelectionStrategy'] end if attributes.has_key?(:'spaceViewId') self.space_view_id = attributes[:'spaceViewId'] end end
Attribute type mapping.
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 138 def self.swagger_types { :'allowed_payment_method_brands' => :'Array<PaymentMethodBrand>', :'allowed_payment_method_configurations' => :'Array<Integer>', :'billing_address' => :'AddressCreate', :'completion_behavior' => :'TransactionCompletionBehavior', :'currency' => :'String', :'customer_email_address' => :'String', :'customer_id' => :'String', :'failed_url' => :'String', :'invoice_merchant_reference' => :'String', :'language' => :'String', :'line_items' => :'Array<LineItemCreate>', :'merchant_reference' => :'String', :'meta_data' => :'Hash<String, String>', :'shipping_address' => :'AddressCreate', :'shipping_method' => :'String', :'success_url' => :'String', :'time_zone' => :'String', :'token' => :'Integer', :'tokenization_mode' => :'TokenizationMode', :'auto_confirmation_enabled' => :'BOOLEAN', :'charge_retry_enabled' => :'BOOLEAN', :'customers_presence' => :'CustomersPresence', :'device_session_identifier' => :'String', :'emails_disabled' => :'BOOLEAN', :'environment' => :'Environment', :'environment_selection_strategy' => :'TransactionEnvironmentSelectionStrategy', :'space_view_id' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 447 def ==(o) return true if self.equal?(o) self.class == o.class && allowed_payment_method_brands == o.allowed_payment_method_brands && allowed_payment_method_configurations == o.allowed_payment_method_configurations && billing_address == o.billing_address && completion_behavior == o.completion_behavior && currency == o.currency && customer_email_address == o.customer_email_address && customer_id == o.customer_id && failed_url == o.failed_url && invoice_merchant_reference == o.invoice_merchant_reference && language == o.language && line_items == o.line_items && merchant_reference == o.merchant_reference && meta_data == o.meta_data && shipping_address == o.shipping_address && shipping_method == o.shipping_method && success_url == o.success_url && time_zone == o.time_zone && token == o.token && tokenization_mode == o.tokenization_mode && auto_confirmation_enabled == o.auto_confirmation_enabled && charge_retry_enabled == o.charge_retry_enabled && customers_presence == o.customers_presence && device_session_identifier == o.device_session_identifier && emails_disabled == o.emails_disabled && environment == o.environment && environment_selection_strategy == o.environment_selection_strategy && space_view_id == o.space_view_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/wallee-ruby-sdk/models/transaction_create.rb, line 515 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 = Wallee.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/wallee-ruby-sdk/models/transaction_create.rb, line 581 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/wallee-ruby-sdk/models/transaction_create.rb, line 494 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 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
Custom attribute writer method with validation @param [Object] customer_email_address
Value to be assigned
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 365 def customer_email_address=(customer_email_address) if !customer_email_address.nil? && customer_email_address.to_s.length > 254 fail ArgumentError, 'invalid value for "customer_email_address", the character length must be smaller than or equal to 254.' end @customer_email_address = customer_email_address end
Custom attribute writer method with validation @param [Object] device_session_identifier
Value to be assigned
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 433 def device_session_identifier=(device_session_identifier) if !device_session_identifier.nil? && device_session_identifier.to_s.length > 40 fail ArgumentError, 'invalid value for "device_session_identifier", the character length must be smaller than or equal to 40.' end if !device_session_identifier.nil? && device_session_identifier.to_s.length < 10 fail ArgumentError, 'invalid value for "device_session_identifier", the character length must be great than or equal to 10.' end @device_session_identifier = device_session_identifier end
@see the `==` method @param [Object] Object to be compared
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 481 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] failed_url
Value to be assigned
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 375 def failed_url=(failed_url) if !failed_url.nil? && failed_url.to_s.length > 1000 fail ArgumentError, 'invalid value for "failed_url", the character length must be smaller than or equal to 1000.' end if !failed_url.nil? && failed_url.to_s.length < 9 fail ArgumentError, 'invalid value for "failed_url", the character length must be great than or equal to 9.' end @failed_url = failed_url end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 487 def hash [allowed_payment_method_brands, allowed_payment_method_configurations, billing_address, completion_behavior, currency, customer_email_address, customer_id, failed_url, invoice_merchant_reference, language, line_items, merchant_reference, meta_data, shipping_address, shipping_method, success_url, time_zone, token, tokenization_mode, auto_confirmation_enabled, charge_retry_enabled, customers_presence, device_session_identifier, emails_disabled, environment, environment_selection_strategy, space_view_id].hash end
Custom attribute writer method with validation @param [Object] invoice_merchant_reference
Value to be assigned
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 389 def invoice_merchant_reference=(invoice_merchant_reference) if !invoice_merchant_reference.nil? && invoice_merchant_reference.to_s.length > 100 fail ArgumentError, 'invalid value for "invoice_merchant_reference", the character length must be smaller than or equal to 100.' end @invoice_merchant_reference = invoice_merchant_reference end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 297 def list_invalid_properties invalid_properties = Array.new if !@customer_email_address.nil? && @customer_email_address.to_s.length > 254 invalid_properties.push('invalid value for "customer_email_address", the character length must be smaller than or equal to 254.') end if !@failed_url.nil? && @failed_url.to_s.length > 1000 invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 1000.') end if !@failed_url.nil? && @failed_url.to_s.length < 9 invalid_properties.push('invalid value for "failed_url", the character length must be great than or equal to 9.') end if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100 invalid_properties.push('invalid value for "invoice_merchant_reference", the character length must be smaller than or equal to 100.') end if @line_items.nil? invalid_properties.push('invalid value for "line_items", line_items cannot be nil.') end if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100 invalid_properties.push('invalid value for "merchant_reference", the character length must be smaller than or equal to 100.') end if !@shipping_method.nil? && @shipping_method.to_s.length > 200 invalid_properties.push('invalid value for "shipping_method", the character length must be smaller than or equal to 200.') end if !@success_url.nil? && @success_url.to_s.length > 1000 invalid_properties.push('invalid value for "success_url", the character length must be smaller than or equal to 1000.') end if !@success_url.nil? && @success_url.to_s.length < 9 invalid_properties.push('invalid value for "success_url", the character length must be great than or equal to 9.') end if !@device_session_identifier.nil? && @device_session_identifier.to_s.length > 40 invalid_properties.push('invalid value for "device_session_identifier", the character length must be smaller than or equal to 40.') end if !@device_session_identifier.nil? && @device_session_identifier.to_s.length < 10 invalid_properties.push('invalid value for "device_session_identifier", the character length must be great than or equal to 10.') end invalid_properties end
Custom attribute writer method with validation @param [Object] merchant_reference
Value to be assigned
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 399 def merchant_reference=(merchant_reference) if !merchant_reference.nil? && merchant_reference.to_s.length > 100 fail ArgumentError, 'invalid value for "merchant_reference", the character length must be smaller than or equal to 100.' end @merchant_reference = merchant_reference end
Custom attribute writer method with validation @param [Object] shipping_method
Value to be assigned
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 409 def shipping_method=(shipping_method) if !shipping_method.nil? && shipping_method.to_s.length > 200 fail ArgumentError, 'invalid value for "shipping_method", the character length must be smaller than or equal to 200.' end @shipping_method = shipping_method end
Custom attribute writer method with validation @param [Object] success_url
Value to be assigned
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 419 def success_url=(success_url) if !success_url.nil? && success_url.to_s.length > 1000 fail ArgumentError, 'invalid value for "success_url", the character length must be smaller than or equal to 1000.' end if !success_url.nil? && success_url.to_s.length < 9 fail ArgumentError, 'invalid value for "success_url", the character length must be great than or equal to 9.' end @success_url = success_url end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 567 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/wallee-ruby-sdk/models/transaction_create.rb, line 555 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/wallee-ruby-sdk/models/transaction_create.rb, line 348 def valid? return false if !@customer_email_address.nil? && @customer_email_address.to_s.length > 254 return false if !@failed_url.nil? && @failed_url.to_s.length > 1000 return false if !@failed_url.nil? && @failed_url.to_s.length < 9 return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100 return false if @line_items.nil? return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100 return false if !@shipping_method.nil? && @shipping_method.to_s.length > 200 return false if !@success_url.nil? && @success_url.to_s.length > 1000 return false if !@success_url.nil? && @success_url.to_s.length < 9 return false if !@device_session_identifier.nil? && @device_session_identifier.to_s.length > 40 return false if !@device_session_identifier.nil? && @device_session_identifier.to_s.length < 10 true end