class Conekta::OrderRequest
a order
Attributes
List of [charges](developers.conekta.com/v2.2.0/reference/orderscreatecharge) that are applied to the order
Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](es.wikipedia.org/wiki/ISO_4217)
List of [discounts](developers.conekta.com/v2.2.0/reference/orderscreatediscountline) that are applied to the order. You must have at least one discount.
List of [products](developers.conekta.com/v2.2.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product.
Metadata associated with the order
Allows you to fill out the shipping information at checkout
Indicates the processing mode for the order, either ecommerce, recurrent or validation.
Indicates the redirection callback upon completion of the 3DS2 flow. Do not use this parameter if your order has a checkout parameter
List of [shipping costs](developers.conekta.com/v2.2.0/reference/orderscreateshipping). If the online store offers digital products.
List of [taxes](developers.conekta.com/v2.2.0/reference/orderscreatetaxes) that are applied to the order.
Indicates the 3DS2 mode for the order, either smart or strict.
Public Class Methods
Source
# File lib/conekta/models/order_request.rb, line 348 def self._deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Conekta.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/conekta/models/order_request.rb, line 86 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/conekta/models/order_request.rb, line 64 def self.attribute_map { :'charges' => :'charges', :'checkout' => :'checkout', :'currency' => :'currency', :'customer_info' => :'customer_info', :'discount_lines' => :'discount_lines', :'fiscal_entity' => :'fiscal_entity', :'line_items' => :'line_items', :'metadata' => :'metadata', :'needs_shipping_contact' => :'needs_shipping_contact', :'pre_authorize' => :'pre_authorize', :'processing_mode' => :'processing_mode', :'return_url' => :'return_url', :'shipping_contact' => :'shipping_contact', :'shipping_lines' => :'shipping_lines', :'tax_lines' => :'tax_lines', :'three_ds_mode' => :'three_ds_mode' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/conekta/models/order_request.rb, line 324 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif 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) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/conekta/models/order_request.rb, line 120 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Conekta::OrderRequest` 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 `Conekta::OrderRequest`. 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?(:'charges') if (value = attributes[:'charges']).is_a?(Array) self.charges = value end end if attributes.key?(:'checkout') self.checkout = attributes[:'checkout'] end if attributes.key?(:'currency') self.currency = attributes[:'currency'] else self.currency = nil end if attributes.key?(:'customer_info') self.customer_info = attributes[:'customer_info'] else self.customer_info = nil end if attributes.key?(:'discount_lines') if (value = attributes[:'discount_lines']).is_a?(Array) self.discount_lines = value end end if attributes.key?(:'fiscal_entity') self.fiscal_entity = attributes[:'fiscal_entity'] end if attributes.key?(:'line_items') if (value = attributes[:'line_items']).is_a?(Array) self.line_items = value end else self.line_items = nil end if attributes.key?(:'metadata') if (value = attributes[:'metadata']).is_a?(Hash) self.metadata = value end end if attributes.key?(:'needs_shipping_contact') self.needs_shipping_contact = attributes[:'needs_shipping_contact'] end if attributes.key?(:'pre_authorize') self.pre_authorize = attributes[:'pre_authorize'] else self.pre_authorize = false end if attributes.key?(:'processing_mode') self.processing_mode = attributes[:'processing_mode'] end if attributes.key?(:'return_url') self.return_url = attributes[:'return_url'] end if attributes.key?(:'shipping_contact') self.shipping_contact = attributes[:'shipping_contact'] end if attributes.key?(:'shipping_lines') if (value = attributes[:'shipping_lines']).is_a?(Array) self.shipping_lines = value end end if attributes.key?(:'tax_lines') if (value = attributes[:'tax_lines']).is_a?(Array) self.tax_lines = value end end if attributes.key?(:'three_ds_mode') self.three_ds_mode = attributes[:'three_ds_mode'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/conekta/models/order_request.rb, line 113 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/conekta/models/order_request.rb, line 91 def self.openapi_types { :'charges' => :'Array<ChargeRequest>', :'checkout' => :'CheckoutRequest', :'currency' => :'String', :'customer_info' => :'OrderRequestCustomerInfo', :'discount_lines' => :'Array<OrderDiscountLinesRequest>', :'fiscal_entity' => :'OrderFiscalEntityRequest', :'line_items' => :'Array<Product>', :'metadata' => :'Hash<String, Object>', :'needs_shipping_contact' => :'Boolean', :'pre_authorize' => :'Boolean', :'processing_mode' => :'String', :'return_url' => :'String', :'shipping_contact' => :'CustomerShippingContacts', :'shipping_lines' => :'Array<ShippingRequest>', :'tax_lines' => :'Array<OrderTaxRequest>', :'three_ds_mode' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/conekta/models/order_request.rb, line 288 def ==(o) return true if self.equal?(o) self.class == o.class && charges == o.charges && checkout == o.checkout && currency == o.currency && customer_info == o.customer_info && discount_lines == o.discount_lines && fiscal_entity == o.fiscal_entity && line_items == o.line_items && metadata == o.metadata && needs_shipping_contact == o.needs_shipping_contact && pre_authorize == o.pre_authorize && processing_mode == o.processing_mode && return_url == o.return_url && shipping_contact == o.shipping_contact && shipping_lines == o.shipping_lines && tax_lines == o.tax_lines && three_ds_mode == o.three_ds_mode end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/conekta/models/order_request.rb, line 419 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
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
Source
# File lib/conekta/models/order_request.rb, line 260 def currency=(currency) if currency.nil? fail ArgumentError, 'currency cannot be nil' end if currency.to_s.length > 3 fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.' end @currency = currency end
Custom attribute writer method with validation @param [Object] currency Value to be assigned
Source
# File lib/conekta/models/order_request.rb, line 311 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/conekta/models/order_request.rb, line 317 def hash [charges, checkout, currency, customer_info, discount_lines, fiscal_entity, line_items, metadata, needs_shipping_contact, pre_authorize, processing_mode, return_url, shipping_contact, shipping_lines, tax_lines, three_ds_mode].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/conekta/models/order_request.rb, line 220 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @currency.nil? invalid_properties.push('invalid value for "currency", currency cannot be nil.') end if @currency.to_s.length > 3 invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.') end if @customer_info.nil? invalid_properties.push('invalid value for "customer_info", customer_info cannot be nil.') end if @line_items.nil? invalid_properties.push('invalid value for "line_items", line_items cannot be nil.') end if !@metadata.nil? && @metadata.length > 100 invalid_properties.push('invalid value for "metadata", number of items must be less than or equal to 100.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/conekta/models/order_request.rb, line 274 def metadata=(metadata) if metadata.nil? fail ArgumentError, 'metadata cannot be nil' end if metadata.length > 100 fail ArgumentError, 'invalid value for "metadata", number of items must be less than or equal to 100.' end @metadata = metadata end
Custom attribute writer method with validation @param [Object] metadata Value to be assigned
Source
Source
# File lib/conekta/models/order_request.rb, line 401 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.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 object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/conekta/models/order_request.rb, line 389 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/conekta/models/order_request.rb, line 248 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @currency.nil? return false if @currency.to_s.length > 3 return false if @customer_info.nil? return false if @line_items.nil? return false if !@metadata.nil? && @metadata.length > 100 true end
Check to see if the all the properties in the model are valid @return true if the model is valid