Class: Tradenity::Payment
- Inherits:
-
Object
- Object
- Tradenity::Payment
- Defined in:
- lib/tradenity/resources/payment.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#__meta ⇒ Object
Returns the value of attribute __meta.
-
#amount ⇒ Object
Returns the value of attribute amount.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#currency ⇒ Object
Returns the value of attribute currency.
-
#order ⇒ Object
Returns the value of attribute order.
-
#payment_source ⇒ Object
Returns the value of attribute payment_source.
-
#status ⇒ Object
Returns the value of attribute status.
-
#updated_at ⇒ Object
Returns the value of attribute updated_at.
Class Method Summary collapse
- .api_client ⇒ Object
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.find_all ⇒ Page<Payment>
List Payments Return a list of Payments.
-
.find_all_by(opts = {}) ⇒ Page<Collection>
Find List of Payment Return multiple instances of Payment by its attributes.
-
.find_one_by(opts = {}) ⇒ Payment
Find Payment by its parameters Return single instance of Collection by its attributes.
-
.list_all_payments(opts = {}) ⇒ Page<Payment>
List Payments Return a list of Payments.
-
.list_all_payments_with_http_info(opts = {}) ⇒ Array<(Page<Payment>, Fixnum, Hash)>
List Payments Return a list of Payments.
-
.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.
- #id ⇒ Object
- #id=(id) ⇒ Object
-
#initialize(attributes = {}) ⇒ Payment
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 = {}) ⇒ Payment
Initializes the object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/tradenity/resources/payment.rb', line 102 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'__meta') self. = attributes[:'__meta'] end if attributes.has_key?(:'createdAt') self.created_at = attributes[:'createdAt'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'updatedAt') self.updated_at = attributes[:'updatedAt'] end if attributes.has_key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end if attributes.has_key?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'order') self.order = attributes[:'order'] end if attributes.has_key?(:'paymentSource') self.payment_source = attributes[:'paymentSource'] end if attributes.has_key?(:'payment_source') self.payment_source = attributes[:'payment_source'] end if attributes.has_key?(:'currency') self.currency = attributes[:'currency'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end end |
Instance Attribute Details
#__meta ⇒ Object
Returns the value of attribute __meta.
32 33 34 |
# File 'lib/tradenity/resources/payment.rb', line 32 def @__meta end |
#amount ⇒ Object
Returns the value of attribute amount.
38 39 40 |
# File 'lib/tradenity/resources/payment.rb', line 38 def amount @amount end |
#created_at ⇒ Object
Returns the value of attribute created_at.
34 35 36 |
# File 'lib/tradenity/resources/payment.rb', line 34 def created_at @created_at end |
#currency ⇒ Object
Returns the value of attribute currency.
44 45 46 |
# File 'lib/tradenity/resources/payment.rb', line 44 def currency @currency end |
#order ⇒ Object
Returns the value of attribute order.
40 41 42 |
# File 'lib/tradenity/resources/payment.rb', line 40 def order @order end |
#payment_source ⇒ Object
Returns the value of attribute payment_source.
42 43 44 |
# File 'lib/tradenity/resources/payment.rb', line 42 def payment_source @payment_source end |
#status ⇒ Object
Returns the value of attribute status.
46 47 48 |
# File 'lib/tradenity/resources/payment.rb', line 46 def status @status end |
#updated_at ⇒ Object
Returns the value of attribute updated_at.
36 37 38 |
# File 'lib/tradenity/resources/payment.rb', line 36 def updated_at @updated_at end |
Class Method Details
.api_client ⇒ Object
338 339 340 |
# File 'lib/tradenity/resources/payment.rb', line 338 def self.api_client ApiClient.default end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/tradenity/resources/payment.rb', line 71 def self.attribute_map { :'id' => :'id', :'__meta' => :'__meta', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt', :'amount' => :'amount', :'order' => :'order', :'payment_source' => :'paymentSource', :'currency' => :'currency', :'status' => :'status' } end |
.find_all ⇒ Page<Payment>
List Payments Return a list of Payments
349 350 351 |
# File 'lib/tradenity/resources/payment.rb', line 349 def find_all list_all_payments end |
.find_all_by(opts = {}) ⇒ Page<Collection>
Find List of Payment Return multiple instances of Payment by its attributes.
357 358 359 |
# File 'lib/tradenity/resources/payment.rb', line 357 def find_all_by(opts = {}) list_all_payments(opts) end |
.find_one_by(opts = {}) ⇒ Payment
Find Payment by its parameters Return single instance of Collection by its attributes.
365 366 367 |
# File 'lib/tradenity/resources/payment.rb', line 365 def find_one_by(opts = {}) list_all_payments(opts)[0] end |
.list_all_payments(opts = {}) ⇒ Page<Payment>
List Payments Return a list of Payments
377 378 379 380 |
# File 'lib/tradenity/resources/payment.rb', line 377 def list_all_payments(opts = {}) data, _status_code, _headers = list_all_payments_with_http_info(opts) data end |
.list_all_payments_with_http_info(opts = {}) ⇒ Array<(Page<Payment>, Fixnum, Hash)>
List Payments Return a list of Payments
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
# File 'lib/tradenity/resources/payment.rb', line 389 def list_all_payments_with_http_info(opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: Payment.list_all_payments ...' end # resource path local_var_path = '/payments' # query parameters query_params = opts # query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? # query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? # query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Page<Payment>') if api_client.config.debugging api_client.config.logger.debug "API called: Payment#list_all_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
.swagger_types ⇒ Object
Attribute type mapping.
86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/tradenity/resources/payment.rb', line 86 def self.swagger_types { :'id' => :'String', :'__meta' => :'InstanceMeta', :'created_at' => :'DateTime', :'updated_at' => :'DateTime', :'amount' => :'Integer', :'order' => :'Order', :'payment_source' => :'PaymentSource', :'currency' => :'Currency', :'status' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/tradenity/resources/payment.rb', line 208 def ==(o) return true if self.equal?(o) self.class == o.class && == o. && created_at == o.created_at && updated_at == o.updated_at && amount == o.amount && order == o.order && payment_source == o.payment_source && currency == o.currency && status == o.status end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
257 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 |
# File 'lib/tradenity/resources/payment.rb', line 257 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 = Tradenity.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
323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/tradenity/resources/payment.rb', line 323 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
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/tradenity/resources/payment.rb', line 236 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
223 224 225 |
# File 'lib/tradenity/resources/payment.rb', line 223 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
229 230 231 |
# File 'lib/tradenity/resources/payment.rb', line 229 def hash [, created_at, updated_at, amount, order, payment_source, currency, status].hash end |
#id ⇒ Object
21 22 23 24 25 26 27 28 29 30 |
# File 'lib/tradenity/resources/payment.rb', line 21 def id if instance_variable_defined?('@id') && @id != nil @id elsif && .href != nil @id = .href.split('/')[-1] @id else nil end end |
#id=(id) ⇒ Object
17 18 19 |
# File 'lib/tradenity/resources/payment.rb', line 17 def id=(id) @id = id end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/tradenity/resources/payment.rb', line 158 def list_invalid_properties invalid_properties = Array.new if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @order.nil? invalid_properties.push('invalid value for "order", order cannot be nil.') end if @payment_source.nil? invalid_properties.push('invalid value for "payment_source", payment_source cannot be nil.') end if @currency.nil? invalid_properties.push('invalid value for "currency", currency cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
303 304 305 |
# File 'lib/tradenity/resources/payment.rb', line 303 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
309 310 311 312 313 314 315 316 317 |
# File 'lib/tradenity/resources/payment.rb', line 309 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
297 298 299 |
# File 'lib/tradenity/resources/payment.rb', line 297 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
185 186 187 188 189 190 191 192 193 194 |
# File 'lib/tradenity/resources/payment.rb', line 185 def valid? return false if @amount.nil? return false if @order.nil? return false if @payment_source.nil? return false if @currency.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ['pending', 'awaitingRetry', 'successful', 'failed']) return false unless status_validator.valid?(@status) true end |