Class: Tremendous::PaymentDetails
- Inherits:
-
Object
- Object
- Tremendous::PaymentDetails
- Defined in:
- lib/tremendous/models/payment_details.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#channel ⇒ Object
Name of the channel in which the order was created.
-
#fees ⇒ Object
Fees for the order (in USD).
-
#refund ⇒ Object
Returns the value of attribute refund.
-
#subtotal ⇒ Object
Total price of the order before fees (in USD).
-
#total ⇒ Object
Total price of the order including fees (in USD).
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PaymentDetails
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 = {}) ⇒ PaymentDetails
Initializes the object
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/tremendous/models/payment_details.rb', line 89 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::PaymentDetails` 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 `Tremendous::PaymentDetails`. 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?(:'subtotal') self.subtotal = attributes[:'subtotal'] end if attributes.key?(:'total') self.total = attributes[:'total'] end if attributes.key?(:'fees') self.fees = attributes[:'fees'] end if attributes.key?(:'refund') self.refund = attributes[:'refund'] end if attributes.key?(:'channel') self.channel = attributes[:'channel'] end end |
Instance Attribute Details
#channel ⇒ Object
Name of the channel in which the order was created
30 31 32 |
# File 'lib/tremendous/models/payment_details.rb', line 30 def channel @channel end |
#fees ⇒ Object
Fees for the order (in USD)
25 26 27 |
# File 'lib/tremendous/models/payment_details.rb', line 25 def fees @fees end |
#refund ⇒ Object
Returns the value of attribute refund.
27 28 29 |
# File 'lib/tremendous/models/payment_details.rb', line 27 def refund @refund end |
#subtotal ⇒ Object
Total price of the order before fees (in USD)
19 20 21 |
# File 'lib/tremendous/models/payment_details.rb', line 19 def subtotal @subtotal end |
#total ⇒ Object
Total price of the order including fees (in USD)
22 23 24 |
# File 'lib/tremendous/models/payment_details.rb', line 22 def total @total end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/tremendous/models/payment_details.rb', line 258 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 = Tremendous.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 |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
66 67 68 |
# File 'lib/tremendous/models/payment_details.rb', line 66 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
55 56 57 58 59 60 61 62 63 |
# File 'lib/tremendous/models/payment_details.rb', line 55 def self.attribute_map { :'subtotal' => :'subtotal', :'total' => :'total', :'fees' => :'fees', :'refund' => :'refund', :'channel' => :'channel' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/tremendous/models/payment_details.rb', line 234 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 |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
82 83 84 85 |
# File 'lib/tremendous/models/payment_details.rb', line 82 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
71 72 73 74 75 76 77 78 79 |
# File 'lib/tremendous/models/payment_details.rb', line 71 def self.openapi_types { :'subtotal' => :'Float', :'total' => :'Float', :'fees' => :'Float', :'refund' => :'PaymentDetailsRefund', :'channel' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
209 210 211 212 213 214 215 216 217 |
# File 'lib/tremendous/models/payment_details.rb', line 209 def ==(o) return true if self.equal?(o) self.class == o.class && subtotal == o.subtotal && total == o.total && fees == o.fees && refund == o.refund && channel == o.channel end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/tremendous/models/payment_details.rb', line 329 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 |
#eql?(o) ⇒ Boolean
221 222 223 |
# File 'lib/tremendous/models/payment_details.rb', line 221 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
227 228 229 |
# File 'lib/tremendous/models/payment_details.rb', line 227 def hash [subtotal, total, fees, refund, channel].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/tremendous/models/payment_details.rb', line 125 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if !@subtotal.nil? && @subtotal < 0 invalid_properties.push('invalid value for "subtotal", must be greater than or equal to 0.') end if !@total.nil? && @total < 0 invalid_properties.push('invalid value for "total", must be greater than or equal to 0.') end if !@fees.nil? && @fees < 0 invalid_properties.push('invalid value for "fees", must be greater than or equal to 0.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
305 306 307 |
# File 'lib/tremendous/models/payment_details.rb', line 305 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/tremendous/models/payment_details.rb', line 311 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 |
#to_s ⇒ String
Returns the string representation of the object
299 300 301 |
# File 'lib/tremendous/models/payment_details.rb', line 299 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
145 146 147 148 149 150 151 152 153 |
# File 'lib/tremendous/models/payment_details.rb', line 145 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if !@subtotal.nil? && @subtotal < 0 return false if !@total.nil? && @total < 0 return false if !@fees.nil? && @fees < 0 channel_validator = EnumAttributeValidator.new('String', ["UI", "API", "EMBED", "DECIPHER", "QUALTRICS", "TYPEFORM", "SURVEY MONKEY"]) return false unless channel_validator.valid?(@channel) true end |