class Conekta::OrderUpdateRequest
a order
Attributes
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.1.0/reference/orderscreatediscountline) that are applied to the order. You must have at least one discount.
List of [products](developers.conekta.com/v2.1.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product.
List of [shipping costs](developers.conekta.com/v2.1.0/reference/orderscreateshipping). If the online store offers digital products.
Public Class Methods
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/conekta/models/order_update_request.rb, line 265 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
Returns all the JSON keys this model knows about
# File lib/conekta/models/order_update_request.rb, line 67 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/conekta/models/order_update_request.rb, line 49 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', :'pre_authorize' => :'pre_authorize', :'shipping_contact' => :'shipping_contact', :'shipping_lines' => :'shipping_lines', :'tax_lines' => :'tax_lines' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/conekta/models/order_update_request.rb, line 241 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/conekta/models/order_update_request.rb, line 97 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Conekta::OrderUpdateRequest` 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::OrderUpdateRequest`. 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'] end if attributes.key?(:'customer_info') self.customer_info = attributes[:'customer_info'] 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 end if attributes.key?(:'metadata') if (value = attributes[:'metadata']).is_a?(Hash) self.metadata = value end end if attributes.key?(:'pre_authorize') self.pre_authorize = attributes[:'pre_authorize'] else self.pre_authorize = false 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 end
List of attributes with nullable: true
# File lib/conekta/models/order_update_request.rb, line 90 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/conekta/models/order_update_request.rb, line 72 def self.openapi_types { :'charges' => :'Array<ChargeRequest>', :'checkout' => :'CheckoutRequest', :'currency' => :'String', :'customer_info' => :'OrderUpdateRequestCustomerInfo', :'discount_lines' => :'Array<OrderDiscountLinesRequest>', :'fiscal_entity' => :'OrderUpdateFiscalEntityRequest', :'line_items' => :'Array<Product>', :'metadata' => :'Hash<String, String>', :'pre_authorize' => :'Boolean', :'shipping_contact' => :'CustomerShippingContacts', :'shipping_lines' => :'Array<ShippingRequest>', :'tax_lines' => :'Array<OrderTaxRequest>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/conekta/models/order_update_request.rb, line 209 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 && pre_authorize == o.pre_authorize && shipping_contact == o.shipping_contact && shipping_lines == o.shipping_lines && tax_lines == o.tax_lines 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/conekta/models/order_update_request.rb, line 336 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
Custom attribute writer method with validation @param [Object] currency Value to be assigned
# File lib/conekta/models/order_update_request.rb, line 195 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/conekta/models/order_update_request.rb, line 228 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/conekta/models/order_update_request.rb, line 234 def hash [charges, checkout, currency, customer_info, discount_lines, fiscal_entity, line_items, metadata, pre_authorize, shipping_contact, shipping_lines, tax_lines].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/conekta/models/order_update_request.rb, line 175 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if !@currency.nil? && @currency.to_s.length > 3 invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/conekta/models/order_update_request.rb, line 318 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 string representation of the object @return [String] String presentation of the object
# File lib/conekta/models/order_update_request.rb, line 306 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/conekta/models/order_update_request.rb, line 187 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if !@currency.nil? && @currency.to_s.length > 3 true end