class Wallee::SubscriptionChargeCreate
The subscription charge represents a single charge carried out for a particular subscription.
Attributes
A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
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.
The field subscription indicates the subscription to which the charge belongs to.
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.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/wallee-ruby-sdk/models/subscription_charge_create.rb, line 45 def self.attribute_map { :'external_id' => :'externalId', :'failed_url' => :'failedUrl', :'planned_execution_date' => :'plannedExecutionDate', :'processing_type' => :'processingType', :'reference' => :'reference', :'subscription' => :'subscription', :'success_url' => :'successUrl' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/wallee-ruby-sdk/models/subscription_charge_create.rb, line 72 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?(:'externalId') self.external_id = attributes[:'externalId'] end if attributes.has_key?(:'failedUrl') self.failed_url = attributes[:'failedUrl'] end if attributes.has_key?(:'plannedExecutionDate') self.planned_execution_date = attributes[:'plannedExecutionDate'] end if attributes.has_key?(:'processingType') self.processing_type = attributes[:'processingType'] end if attributes.has_key?(:'reference') self.reference = attributes[:'reference'] end if attributes.has_key?(:'subscription') self.subscription = attributes[:'subscription'] end if attributes.has_key?(:'successUrl') self.success_url = attributes[:'successUrl'] end end
Attribute type mapping.
# File lib/wallee-ruby-sdk/models/subscription_charge_create.rb, line 58 def self.swagger_types { :'external_id' => :'String', :'failed_url' => :'String', :'planned_execution_date' => :'DateTime', :'processing_type' => :'SubscriptionChargeProcessingType', :'reference' => :'String', :'subscription' => :'Integer', :'success_url' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/wallee-ruby-sdk/models/subscription_charge_create.rb, line 200 def ==(o) return true if self.equal?(o) self.class == o.class && external_id == o.external_id && failed_url == o.failed_url && planned_execution_date == o.planned_execution_date && processing_type == o.processing_type && reference == o.reference && subscription == o.subscription && success_url == o.success_url 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/subscription_charge_create.rb, line 248 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/subscription_charge_create.rb, line 314 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/subscription_charge_create.rb, line 227 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/subscription_charge_create.rb, line 214 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/subscription_charge_create.rb, line 162 def failed_url=(failed_url) if !failed_url.nil? && failed_url.to_s.length > 500 fail ArgumentError, 'invalid value for "failed_url", the character length must be smaller than or equal to 500.' 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/subscription_charge_create.rb, line 220 def hash [external_id, failed_url, planned_execution_date, processing_type, reference, subscription, success_url].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/subscription_charge_create.rb, line 109 def list_invalid_properties invalid_properties = Array.new if @external_id.nil? invalid_properties.push('invalid value for "external_id", external_id cannot be nil.') end if !@failed_url.nil? && @failed_url.to_s.length > 500 invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 500.') 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 @processing_type.nil? invalid_properties.push('invalid value for "processing_type", processing_type cannot be nil.') end if !@reference.nil? && @reference.to_s.length > 100 invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 100.') end if @subscription.nil? invalid_properties.push('invalid value for "subscription", subscription cannot be nil.') end if !@success_url.nil? && @success_url.to_s.length > 500 invalid_properties.push('invalid value for "success_url", the character length must be smaller than or equal to 500.') 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 invalid_properties end
Custom attribute writer method with validation @param [Object] reference Value to be assigned
# File lib/wallee-ruby-sdk/models/subscription_charge_create.rb, line 176 def reference=(reference) if !reference.nil? && reference.to_s.length > 100 fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 100.' end @reference = reference end
Custom attribute writer method with validation @param [Object] success_url
Value to be assigned
# File lib/wallee-ruby-sdk/models/subscription_charge_create.rb, line 186 def success_url=(success_url) if !success_url.nil? && success_url.to_s.length > 500 fail ArgumentError, 'invalid value for "success_url", the character length must be smaller than or equal to 500.' 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/subscription_charge_create.rb, line 300 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/subscription_charge_create.rb, line 288 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/subscription_charge_create.rb, line 148 def valid? return false if @external_id.nil? return false if !@failed_url.nil? && @failed_url.to_s.length > 500 return false if !@failed_url.nil? && @failed_url.to_s.length < 9 return false if @processing_type.nil? return false if !@reference.nil? && @reference.to_s.length > 100 return false if @subscription.nil? return false if !@success_url.nil? && @success_url.to_s.length > 500 return false if !@success_url.nil? && @success_url.to_s.length < 9 true end