class OpenapiClient::PaymentUrlRequest
Request to generate an embedded payment link.
Attributes
If 3D secure should be applied.
Dynamic merchant name for the cardholder's statement.
Time until payment URL expires.
The text to be displayed to the payer on the hosted payment page.
Invoice number.
IPv4 or IPv6 network address.
Note - Client Order
ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM).
Purchase order number.
An optional Outlet ID for clients that support multiple stores in the same developer app.
URL for notifying merchant of payment result.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/openapi_client/models/payment_url_request.rb, line 63 def self.attribute_map { :'store_id' => :'storeId', :'client_locale' => :'clientLocale', :'transaction_amount' => :'transactionAmount', :'transaction_type' => :'transactionType', :'order_id' => :'orderId', :'billing' => :'billing', :'shipping' => :'shipping', :'transaction_notification_url' => :'transactionNotificationURL', :'expiration' => :'expiration', :'authenticate_transaction' => :'authenticateTransaction', :'dynamic_merchant_name' => :'dynamicMerchantName', :'invoice_number' => :'invoiceNumber', :'purchase_order_number' => :'purchaseOrderNumber', :'hosted_payment_page_text' => :'hostedPaymentPageText', :'ip' => :'ip', :'revolving_options' => :'revolvingOptions', :'installment_options' => :'installmentOptions' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/openapi_client/models/payment_url_request.rb, line 284 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/openapi_client/models/payment_url_request.rb, line 110 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PaymentUrlRequest` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PaymentUrlRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'store_id') self.store_id = attributes[:'store_id'] end if attributes.key?(:'client_locale') self.client_locale = attributes[:'client_locale'] end if attributes.key?(:'transaction_amount') self.transaction_amount = attributes[:'transaction_amount'] end if attributes.key?(:'transaction_type') self.transaction_type = attributes[:'transaction_type'] end if attributes.key?(:'order_id') self.order_id = attributes[:'order_id'] end if attributes.key?(:'billing') self.billing = attributes[:'billing'] end if attributes.key?(:'shipping') self.shipping = attributes[:'shipping'] end if attributes.key?(:'transaction_notification_url') self.transaction_notification_url = attributes[:'transaction_notification_url'] end if attributes.key?(:'expiration') self.expiration = attributes[:'expiration'] end if attributes.key?(:'authenticate_transaction') self.authenticate_transaction = attributes[:'authenticate_transaction'] end if attributes.key?(:'dynamic_merchant_name') self.dynamic_merchant_name = attributes[:'dynamic_merchant_name'] end if attributes.key?(:'invoice_number') self.invoice_number = attributes[:'invoice_number'] end if attributes.key?(:'purchase_order_number') self.purchase_order_number = attributes[:'purchase_order_number'] end if attributes.key?(:'hosted_payment_page_text') self.hosted_payment_page_text = attributes[:'hosted_payment_page_text'] end if attributes.key?(:'ip') self.ip = attributes[:'ip'] end if attributes.key?(:'revolving_options') self.revolving_options = attributes[:'revolving_options'] end if attributes.key?(:'installment_options') self.installment_options = attributes[:'installment_options'] end end
Attribute type mapping.
# File lib/openapi_client/models/payment_url_request.rb, line 86 def self.openapi_types { :'store_id' => :'String', :'client_locale' => :'ClientLocale', :'transaction_amount' => :'Amount', :'transaction_type' => :'TransactionType', :'order_id' => :'String', :'billing' => :'Billing', :'shipping' => :'Shipping', :'transaction_notification_url' => :'String', :'expiration' => :'Integer', :'authenticate_transaction' => :'Boolean', :'dynamic_merchant_name' => :'String', :'invoice_number' => :'String', :'purchase_order_number' => :'String', :'hosted_payment_page_text' => :'String', :'ip' => :'String', :'revolving_options' => :'RevolvingOptions', :'installment_options' => :'InstallmentOptions' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/openapi_client/models/payment_url_request.rb, line 247 def ==(o) return true if self.equal?(o) self.class == o.class && store_id == o.store_id && client_locale == o.client_locale && transaction_amount == o.transaction_amount && transaction_type == o.transaction_type && order_id == o.order_id && billing == o.billing && shipping == o.shipping && transaction_notification_url == o.transaction_notification_url && expiration == o.expiration && authenticate_transaction == o.authenticate_transaction && dynamic_merchant_name == o.dynamic_merchant_name && invoice_number == o.invoice_number && purchase_order_number == o.purchase_order_number && hosted_payment_page_text == o.hosted_payment_page_text && ip == o.ip && revolving_options == o.revolving_options && installment_options == o.installment_options 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/openapi_client/models/payment_url_request.rb, line 312 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 klass = OpenapiClient.const_get(type) if klass.respond_to?(:openapi_discriminator_name) klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]]) end klass.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/openapi_client/models/payment_url_request.rb, line 386 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/openapi_client/models/payment_url_request.rb, line 291 def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) return nil unless attributes.is_a?(Hash) openapi_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[attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[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/openapi_client/models/payment_url_request.rb, line 271 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/openapi_client/models/payment_url_request.rb, line 277 def hash [store_id, client_locale, transaction_amount, transaction_type, order_id, billing, shipping, transaction_notification_url, expiration, authenticate_transaction, dynamic_merchant_name, invoice_number, purchase_order_number, hosted_payment_page_text, ip, revolving_options, installment_options].hash end
Custom attribute writer method with validation @param [Object] hosted_payment_page_text
Value to be assigned
# File lib/openapi_client/models/payment_url_request.rb, line 237 def hosted_payment_page_text=(hosted_payment_page_text) if !hosted_payment_page_text.nil? && hosted_payment_page_text.to_s.length > 255 fail ArgumentError, 'invalid value for "hosted_payment_page_text", the character length must be smaller than or equal to 255.' end @hosted_payment_page_text = hosted_payment_page_text end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/openapi_client/models/payment_url_request.rb, line 194 def list_invalid_properties invalid_properties = Array.new if !@store_id.nil? && @store_id.to_s.length > 20 invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.') end if @transaction_amount.nil? invalid_properties.push('invalid value for "transaction_amount", transaction_amount cannot be nil.') end if @transaction_type.nil? invalid_properties.push('invalid value for "transaction_type", transaction_type cannot be nil.') end if !@hosted_payment_page_text.nil? && @hosted_payment_page_text.to_s.length > 255 invalid_properties.push('invalid value for "hosted_payment_page_text", the character length must be smaller than or equal to 255.') end invalid_properties end
Custom attribute writer method with validation @param [Object] store_id
Value to be assigned
# File lib/openapi_client/models/payment_url_request.rb, line 227 def store_id=(store_id) if !store_id.nil? && store_id.to_s.length > 20 fail ArgumentError, 'invalid value for "store_id", the character length must be smaller than or equal to 20.' end @store_id = store_id end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/openapi_client/models/payment_url_request.rb, line 368 def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) hash = {} attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/openapi_client/models/payment_url_request.rb, line 356 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/openapi_client/models/payment_url_request.rb, line 217 def valid? return false if !@store_id.nil? && @store_id.to_s.length > 20 return false if @transaction_amount.nil? return false if @transaction_type.nil? return false if !@hosted_payment_page_text.nil? && @hosted_payment_page_text.to_s.length > 255 true end