class SquareConnect::V1Order
Attributes
For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC).
For Bitcoin transactions, the address that the buyer sent Bitcoin to.
The email address of the order's buyer.
A note provided by the buyer when the order was created, if any.
A note provided by the merchant when the order's state was set to CANCELED, if any.
A note provided by the merchant when the order's state was set to COMPLETED, if any
The time when the order was created, in ISO 8601 format.
Any errors that occurred during the request.
The time when the order expires if no action is taken, in ISO 8601 format.
The order's unique identifier.
The history of actions associated with the order.
The unique identifier of the payment associated with the order.
The promo code provided by the buyer, if any.
The name of the order's buyer.
The phone number to use for the order's delivery.
A note provided by the merchant when the order's state was set to REFUNDED, if any.
The address to ship the order to.
Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. See [V1OrderState](type-v1orderstate) for possible values
The amount of all items purchased in the order, before taxes and shipping.
The tender used to pay for the order.
The total of all discounts applied to the order.
The total cost of the order.
The shipping cost for the order.
The total of all taxes applied to the order.
The time when the order was last modified, in ISO 8601 format.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/v1_order.rb, line 92 def self.attribute_map { :'errors' => :'errors', :'id' => :'id', :'buyer_email' => :'buyer_email', :'recipient_name' => :'recipient_name', :'recipient_phone_number' => :'recipient_phone_number', :'state' => :'state', :'shipping_address' => :'shipping_address', :'subtotal_money' => :'subtotal_money', :'total_shipping_money' => :'total_shipping_money', :'total_tax_money' => :'total_tax_money', :'total_price_money' => :'total_price_money', :'total_discount_money' => :'total_discount_money', :'created_at' => :'created_at', :'updated_at' => :'updated_at', :'expires_at' => :'expires_at', :'payment_id' => :'payment_id', :'buyer_note' => :'buyer_note', :'completed_note' => :'completed_note', :'refunded_note' => :'refunded_note', :'canceled_note' => :'canceled_note', :'tender' => :'tender', :'order_history' => :'order_history', :'promo_code' => :'promo_code', :'btc_receive_address' => :'btc_receive_address', :'btc_price_satoshi' => :'btc_price_satoshi' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/v1_order.rb, line 155 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?(:'errors') if (value = attributes[:'errors']).is_a?(Array) self.errors = value end end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'buyer_email') self.buyer_email = attributes[:'buyer_email'] end if attributes.has_key?(:'recipient_name') self.recipient_name = attributes[:'recipient_name'] end if attributes.has_key?(:'recipient_phone_number') self.recipient_phone_number = attributes[:'recipient_phone_number'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'shipping_address') self.shipping_address = attributes[:'shipping_address'] end if attributes.has_key?(:'subtotal_money') self.subtotal_money = attributes[:'subtotal_money'] end if attributes.has_key?(:'total_shipping_money') self.total_shipping_money = attributes[:'total_shipping_money'] end if attributes.has_key?(:'total_tax_money') self.total_tax_money = attributes[:'total_tax_money'] end if attributes.has_key?(:'total_price_money') self.total_price_money = attributes[:'total_price_money'] end if attributes.has_key?(:'total_discount_money') self.total_discount_money = attributes[:'total_discount_money'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end if attributes.has_key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end if attributes.has_key?(:'payment_id') self.payment_id = attributes[:'payment_id'] end if attributes.has_key?(:'buyer_note') self.buyer_note = attributes[:'buyer_note'] end if attributes.has_key?(:'completed_note') self.completed_note = attributes[:'completed_note'] end if attributes.has_key?(:'refunded_note') self.refunded_note = attributes[:'refunded_note'] end if attributes.has_key?(:'canceled_note') self.canceled_note = attributes[:'canceled_note'] end if attributes.has_key?(:'tender') self.tender = attributes[:'tender'] end if attributes.has_key?(:'order_history') if (value = attributes[:'order_history']).is_a?(Array) self.order_history = value end end if attributes.has_key?(:'promo_code') self.promo_code = attributes[:'promo_code'] end if attributes.has_key?(:'btc_receive_address') self.btc_receive_address = attributes[:'btc_receive_address'] end if attributes.has_key?(:'btc_price_satoshi') self.btc_price_satoshi = attributes[:'btc_price_satoshi'] end end
Attribute type mapping.
# File lib/square_connect/models/v1_order.rb, line 123 def self.swagger_types { :'errors' => :'Array<Error>', :'id' => :'String', :'buyer_email' => :'String', :'recipient_name' => :'String', :'recipient_phone_number' => :'String', :'state' => :'String', :'shipping_address' => :'Address', :'subtotal_money' => :'V1Money', :'total_shipping_money' => :'V1Money', :'total_tax_money' => :'V1Money', :'total_price_money' => :'V1Money', :'total_discount_money' => :'V1Money', :'created_at' => :'String', :'updated_at' => :'String', :'expires_at' => :'String', :'payment_id' => :'String', :'buyer_note' => :'String', :'completed_note' => :'String', :'refunded_note' => :'String', :'canceled_note' => :'String', :'tender' => :'V1Tender', :'order_history' => :'Array<V1OrderHistoryEntry>', :'promo_code' => :'String', :'btc_receive_address' => :'String', :'btc_price_satoshi' => :'Float' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/v1_order.rb, line 282 def ==(o) return true if self.equal?(o) self.class == o.class && errors == o.errors && id == o.id && buyer_email == o.buyer_email && recipient_name == o.recipient_name && recipient_phone_number == o.recipient_phone_number && state == o.state && shipping_address == o.shipping_address && subtotal_money == o.subtotal_money && total_shipping_money == o.total_shipping_money && total_tax_money == o.total_tax_money && total_price_money == o.total_price_money && total_discount_money == o.total_discount_money && created_at == o.created_at && updated_at == o.updated_at && expires_at == o.expires_at && payment_id == o.payment_id && buyer_note == o.buyer_note && completed_note == o.completed_note && refunded_note == o.refunded_note && canceled_note == o.canceled_note && tender == o.tender && order_history == o.order_history && promo_code == o.promo_code && btc_receive_address == o.btc_receive_address && btc_price_satoshi == o.btc_price_satoshi 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/square_connect/models/v1_order.rb, line 348 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 = SquareConnect.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/square_connect/models/v1_order.rb, line 414 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/square_connect/models/v1_order.rb, line 327 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 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/square_connect/models/v1_order.rb, line 314 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/v1_order.rb, line 320 def hash [errors, id, buyer_email, recipient_name, recipient_phone_number, state, shipping_address, subtotal_money, total_shipping_money, total_tax_money, total_price_money, total_discount_money, created_at, updated_at, expires_at, payment_id, buyer_note, completed_note, refunded_note, canceled_note, tender, order_history, promo_code, btc_receive_address, btc_price_satoshi].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/square_connect/models/v1_order.rb, line 269 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/v1_order.rb, line 400 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/square_connect/models/v1_order.rb, line 388 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/square_connect/models/v1_order.rb, line 276 def valid? return true end