class Wallee::PaymentMethodConfiguration
The payment method configuration builds the base to connect with different payment method connectors.
Attributes
The data collection type determines who is collecting the payment information. This can be done either by the processor (offsite) or by our application (onsite).
The payment method configuration description can be used to show a text during the payment process. Choose an appropriate description as it will be displayed to your customer.
The ID is the primary key of the entity. The ID identifies the entity uniquely.
The image of the payment method configuration overrides the default image of the payment method.
The linked space id holds the ID of the space to which the entity belongs to.
The payment method configuration name is used internally to identify the payment method configuration. For example the name is used within search fields and hence it should be distinct and descriptive.
When the buyer is present on the payment page or within the iFrame the payment details can be stored automatically. The buyer will be able to use the stored payment details for subsequent transactions. When the transaction already contains a token one-click payments are disabled anyway
The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
The resolved description uses the specified description or the default one when it is not overridden.
The resolved URL of the image to use with this payment method.
The resolved title uses the specified title or the default one when it is not overridden.
The sort order of the payment method determines the ordering of the methods shown to the user during the payment process.
The title of the payment method configuration is used within the payment process. The title is visible to the customer.
The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/wallee-ruby-sdk/models/payment_method_configuration.rb, line 75 def self.attribute_map { :'data_collection_type' => :'dataCollectionType', :'description' => :'description', :'id' => :'id', :'image_resource_path' => :'imageResourcePath', :'linked_space_id' => :'linkedSpaceId', :'name' => :'name', :'one_click_payment_mode' => :'oneClickPaymentMode', :'payment_method' => :'paymentMethod', :'planned_purge_date' => :'plannedPurgeDate', :'resolved_description' => :'resolvedDescription', :'resolved_image_url' => :'resolvedImageUrl', :'resolved_title' => :'resolvedTitle', :'sort_order' => :'sortOrder', :'space_id' => :'spaceId', :'state' => :'state', :'title' => :'title', :'version' => :'version' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/wallee-ruby-sdk/models/payment_method_configuration.rb, line 122 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?(:'dataCollectionType') self.data_collection_type = attributes[:'dataCollectionType'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'imageResourcePath') self.image_resource_path = attributes[:'imageResourcePath'] end if attributes.has_key?(:'linkedSpaceId') self.linked_space_id = attributes[:'linkedSpaceId'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'oneClickPaymentMode') self.one_click_payment_mode = attributes[:'oneClickPaymentMode'] end if attributes.has_key?(:'paymentMethod') self.payment_method = attributes[:'paymentMethod'] end if attributes.has_key?(:'plannedPurgeDate') self.planned_purge_date = attributes[:'plannedPurgeDate'] end if attributes.has_key?(:'resolvedDescription') if (value = attributes[:'resolvedDescription']).is_a?(Hash) self.resolved_description = value end end if attributes.has_key?(:'resolvedImageUrl') self.resolved_image_url = attributes[:'resolvedImageUrl'] end if attributes.has_key?(:'resolvedTitle') if (value = attributes[:'resolvedTitle']).is_a?(Hash) self.resolved_title = value end end if attributes.has_key?(:'sortOrder') self.sort_order = attributes[:'sortOrder'] end if attributes.has_key?(:'spaceId') self.space_id = attributes[:'spaceId'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'title') self.title = attributes[:'title'] end if attributes.has_key?(:'version') self.version = attributes[:'version'] end end
Attribute type mapping.
# File lib/wallee-ruby-sdk/models/payment_method_configuration.rb, line 98 def self.swagger_types { :'data_collection_type' => :'DataCollectionType', :'description' => :'DatabaseTranslatedString', :'id' => :'Integer', :'image_resource_path' => :'ResourcePath', :'linked_space_id' => :'Integer', :'name' => :'String', :'one_click_payment_mode' => :'OneClickPaymentMode', :'payment_method' => :'Integer', :'planned_purge_date' => :'DateTime', :'resolved_description' => :'Hash<String, String>', :'resolved_image_url' => :'String', :'resolved_title' => :'Hash<String, String>', :'sort_order' => :'Integer', :'space_id' => :'Integer', :'state' => :'CreationEntityState', :'title' => :'DatabaseTranslatedString', :'version' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/wallee-ruby-sdk/models/payment_method_configuration.rb, line 231 def ==(o) return true if self.equal?(o) self.class == o.class && data_collection_type == o.data_collection_type && description == o.description && id == o.id && image_resource_path == o.image_resource_path && linked_space_id == o.linked_space_id && name == o.name && one_click_payment_mode == o.one_click_payment_mode && payment_method == o.payment_method && planned_purge_date == o.planned_purge_date && resolved_description == o.resolved_description && resolved_image_url == o.resolved_image_url && resolved_title == o.resolved_title && sort_order == o.sort_order && space_id == o.space_id && state == o.state && title == o.title && version == o.version 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/payment_method_configuration.rb, line 289 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/payment_method_configuration.rb, line 355 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/payment_method_configuration.rb, line 268 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
@see the `==` method @param [Object] Object to be compared
# File lib/wallee-ruby-sdk/models/payment_method_configuration.rb, line 255 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/wallee-ruby-sdk/models/payment_method_configuration.rb, line 261 def hash [data_collection_type, description, id, image_resource_path, linked_space_id, name, one_click_payment_mode, payment_method, planned_purge_date, resolved_description, resolved_image_url, resolved_title, sort_order, space_id, state, title, version].hash 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/payment_method_configuration.rb, line 203 def list_invalid_properties invalid_properties = Array.new if !@name.nil? && @name.to_s.length > 100 invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.') end invalid_properties end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/wallee-ruby-sdk/models/payment_method_configuration.rb, line 221 def name=(name) if !name.nil? && name.to_s.length > 100 fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.' end @name = name 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/payment_method_configuration.rb, line 341 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/payment_method_configuration.rb, line 329 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/payment_method_configuration.rb, line 214 def valid? return false if !@name.nil? && @name.to_s.length > 100 true end