class UltracartClient::OrderChannelPartner
Attributes
If true, any purchase order submitted is automatically approved
The code of the channel partner
Additional data provided by the channel partner, read-only
Channel partner object identifier, read-only and available on existing channel orders only.
The order ID assigned by the channel partner for this order.
Set to true to ignore invalid shipping method being specified. Only applicable on inserting orders.
Indicates this order should be placed in Account Receivable for later payment processing
Indicates this order was already paid for via a channel purchase and no payment collection should be attempted
Instructs UltraCart to skip shipping department and mark this order as fully complete. This flag defaults to true. Set this flag to false to shipped product for this order.
If true, any failed payment will place the order in Accounts Receivable rather than rejecting it.
Any warnings are raised as errors and halt the import of the order
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ultracart_api/models/order_channel_partner.rb, line 51 def self.attribute_map { :'auto_approve_purchase_order' => :'auto_approve_purchase_order', :'channel_partner_code' => :'channel_partner_code', :'channel_partner_data' => :'channel_partner_data', :'channel_partner_oid' => :'channel_partner_oid', :'channel_partner_order_id' => :'channel_partner_order_id', :'ignore_invalid_shipping_method' => :'ignore_invalid_shipping_method', :'no_realtime_payment_processing' => :'no_realtime_payment_processing', :'skip_payment_processing' => :'skip_payment_processing', :'store_completed' => :'store_completed', :'store_if_payment_declines' => :'store_if_payment_declines', :'treat_warnings_as_errors' => :'treat_warnings_as_errors' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ultracart_api/models/order_channel_partner.rb, line 86 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?(:'auto_approve_purchase_order') self.auto_approve_purchase_order = attributes[:'auto_approve_purchase_order'] end if attributes.has_key?(:'channel_partner_code') self.channel_partner_code = attributes[:'channel_partner_code'] end if attributes.has_key?(:'channel_partner_data') self.channel_partner_data = attributes[:'channel_partner_data'] end if attributes.has_key?(:'channel_partner_oid') self.channel_partner_oid = attributes[:'channel_partner_oid'] end if attributes.has_key?(:'channel_partner_order_id') self.channel_partner_order_id = attributes[:'channel_partner_order_id'] end if attributes.has_key?(:'ignore_invalid_shipping_method') self.ignore_invalid_shipping_method = attributes[:'ignore_invalid_shipping_method'] end if attributes.has_key?(:'no_realtime_payment_processing') self.no_realtime_payment_processing = attributes[:'no_realtime_payment_processing'] end if attributes.has_key?(:'skip_payment_processing') self.skip_payment_processing = attributes[:'skip_payment_processing'] end if attributes.has_key?(:'store_completed') self.store_completed = attributes[:'store_completed'] end if attributes.has_key?(:'store_if_payment_declines') self.store_if_payment_declines = attributes[:'store_if_payment_declines'] end if attributes.has_key?(:'treat_warnings_as_errors') self.treat_warnings_as_errors = attributes[:'treat_warnings_as_errors'] end end
Attribute type mapping.
# File lib/ultracart_api/models/order_channel_partner.rb, line 68 def self.swagger_types { :'auto_approve_purchase_order' => :'BOOLEAN', :'channel_partner_code' => :'String', :'channel_partner_data' => :'String', :'channel_partner_oid' => :'Integer', :'channel_partner_order_id' => :'String', :'ignore_invalid_shipping_method' => :'BOOLEAN', :'no_realtime_payment_processing' => :'BOOLEAN', :'skip_payment_processing' => :'BOOLEAN', :'store_completed' => :'BOOLEAN', :'store_if_payment_declines' => :'BOOLEAN', :'treat_warnings_as_errors' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ultracart_api/models/order_channel_partner.rb, line 167 def ==(o) return true if self.equal?(o) self.class == o.class && auto_approve_purchase_order == o.auto_approve_purchase_order && channel_partner_code == o.channel_partner_code && channel_partner_data == o.channel_partner_data && channel_partner_oid == o.channel_partner_oid && channel_partner_order_id == o.channel_partner_order_id && ignore_invalid_shipping_method == o.ignore_invalid_shipping_method && no_realtime_payment_processing == o.no_realtime_payment_processing && skip_payment_processing == o.skip_payment_processing && store_completed == o.store_completed && store_if_payment_declines == o.store_if_payment_declines && treat_warnings_as_errors == o.treat_warnings_as_errors 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/ultracart_api/models/order_channel_partner.rb, line 219 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 = UltracartClient.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/ultracart_api/models/order_channel_partner.rb, line 285 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/ultracart_api/models/order_channel_partner.rb, line 198 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
Custom attribute writer method with validation @param [Object] channel_partner_order_id
Value to be assigned
# File lib/ultracart_api/models/order_channel_partner.rb, line 157 def channel_partner_order_id=(channel_partner_order_id) if !channel_partner_order_id.nil? && channel_partner_order_id.to_s.length > 50 fail ArgumentError, 'invalid value for "channel_partner_order_id", the character length must be smaller than or equal to 50.' end @channel_partner_order_id = channel_partner_order_id end
@see the `==` method @param [Object] Object to be compared
# File lib/ultracart_api/models/order_channel_partner.rb, line 185 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/ultracart_api/models/order_channel_partner.rb, line 191 def hash [auto_approve_purchase_order, channel_partner_code, channel_partner_data, channel_partner_oid, channel_partner_order_id, ignore_invalid_shipping_method, no_realtime_payment_processing, skip_payment_processing, store_completed, store_if_payment_declines, treat_warnings_as_errors].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ultracart_api/models/order_channel_partner.rb, line 139 def list_invalid_properties invalid_properties = Array.new if !@channel_partner_order_id.nil? && @channel_partner_order_id.to_s.length > 50 invalid_properties.push('invalid value for "channel_partner_order_id", the character length must be smaller than or equal to 50.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ultracart_api/models/order_channel_partner.rb, line 271 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/ultracart_api/models/order_channel_partner.rb, line 259 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/ultracart_api/models/order_channel_partner.rb, line 150 def valid? return false if !@channel_partner_order_id.nil? && @channel_partner_order_id.to_s.length > 50 true end