Class: SquareConnect::CreateOrderRequestModifier
- Inherits:
-
Object
- Object
- SquareConnect::CreateOrderRequestModifier
- Defined in:
- lib/square_connect/models/create_order_request_modifier.rb
Overview
__Deprecated__: Please use the [OrderLineItemModifier](#type-orderlineitemmodifier) type instead. Represents a modifier applied to a single line item. Modifiers can reference existing objects in a merchant catalog or be constructed ad hoc at the time of purchase by providing a name and price.
Instance Attribute Summary collapse
-
#base_price_money ⇒ Object
The base price for the modifier.
-
#catalog_object_id ⇒ Object
The catalog object ID of a [CatalogModifier](#type-catalogmodifier).
-
#name ⇒ Object
Only used for ad hoc modifiers.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateOrderRequestModifier
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ CreateOrderRequestModifier
Initializes the object
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 45 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?(:'catalog_object_id') self.catalog_object_id = attributes[:'catalog_object_id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'base_price_money') self.base_price_money = attributes[:'base_price_money'] end end |
Instance Attribute Details
#base_price_money ⇒ Object
The base price for the modifier. ‘base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined [CatalogModifier](#type-catalogmodifier) price.
22 23 24 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 22 def base_price_money @base_price_money end |
#catalog_object_id ⇒ Object
The catalog object ID of a [CatalogModifier](#type-catalogmodifier).
16 17 18 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 16 def catalog_object_id @catalog_object_id end |
#name ⇒ Object
Only used for ad hoc modifiers. The name of the modifier. ‘name` cannot exceed 255 characters. Do not provide a value for `name` if you provide a value for `catalog_object_id`.
19 20 21 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 19 def name @name end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
26 27 28 29 30 31 32 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 26 def self.attribute_map { :'catalog_object_id' => :'catalog_object_id', :'name' => :'name', :'base_price_money' => :'base_price_money' } end |
.swagger_types ⇒ Object
Attribute type mapping.
35 36 37 38 39 40 41 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 35 def self.swagger_types { :'catalog_object_id' => :'String', :'name' => :'String', :'base_price_money' => :'Money' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
112 113 114 115 116 117 118 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 112 def ==(o) return true if self.equal?(o) self.class == o.class && catalog_object_id == o.catalog_object_id && name == o.name && base_price_money == o.base_price_money end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 156 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 222 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 135 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 |
#eql?(o) ⇒ Boolean
122 123 124 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 122 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
128 129 130 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 128 def hash [catalog_object_id, name, base_price_money].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 67 def list_invalid_properties invalid_properties = Array.new if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192 invalid_properties.push("invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192.") end if !@name.nil? && @name.to_s.length > 255 invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
202 203 204 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 202 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
208 209 210 211 212 213 214 215 216 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 208 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 |
#to_s ⇒ String
Returns the string representation of the object
196 197 198 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 196 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
82 83 84 85 86 |
# File 'lib/square_connect/models/create_order_request_modifier.rb', line 82 def valid? return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192 return false if !@name.nil? && @name.to_s.length > 255 return true end |