Class: MfkOpenapiRubyClient::PayoutRefund

Inherits:
Object
  • Object
show all
Defined in:
lib/mfk_openapi_ruby_client/models/payout_refund.rb

Overview

売り手さまへの振込後に発生したキャンセルに伴う返金です。

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayoutRefund

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 107

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MfkOpenapiRubyClient::PayoutRefund` 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 `MfkOpenapiRubyClient::PayoutRefund`. 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?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'commission_amount')
    self.commission_amount = attributes[:'commission_amount']
  end

  if attributes.key?(:'customer_id')
    self.customer_id = attributes[:'customer_id']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  end

  if attributes.key?(:'payout_id')
    self.payout_id = attributes[:'payout_id']
  end

  if attributes.key?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  end

  if attributes.key?(:'uri')
    self.uri = attributes[:'uri']
  end
end

Instance Attribute Details

#amount ⇒ Object

返金金額です。



20
21
22
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 20

def amount
  @amount
end

#commission_amount ⇒ Object

手数料の金額です。



23
24
25
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 23

def commission_amount
  @commission_amount
end

#customer_id ⇒ Object

顧客IDです。この返金が紐づく顧客を示します。



26
27
28
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 26

def customer_id
  @customer_id
end

#id ⇒ Object

返金IDです。一意の識別子として自動で付与されます。



29
30
31
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 29

def id
  @id
end

#object ⇒ Object

このObjectの種別を示します。ここでは必ず‘payout_refund`が入ります。



32
33
34
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 32

def object
  @object
end

#payout_id ⇒ Object

返金が含まれる振込のIDです。



35
36
37
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 35

def payout_id
  @payout_id
end

#transaction_id ⇒ Object

取引IDです。この返金が紐づく取引を示します。



38
39
40
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 38

def transaction_id
  @transaction_id
end

#uri ⇒ Object

返金URIです。すべてのリソースで一意の識別子として自動で付与されます。



41
42
43
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 41

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 66

def self.attribute_map
  {
    :'amount' => :'amount',
    :'commission_amount' => :'commission_amount',
    :'customer_id' => :'customer_id',
    :'id' => :'id',
    :'object' => :'object',
    :'payout_id' => :'payout_id',
    :'transaction_id' => :'transaction_id',
    :'uri' => :'uri'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



208
209
210
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 208

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 99

def self.openapi_nullable
  Set.new([
    :'commission_amount',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 85

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'commission_amount' => :'Integer',
    :'customer_id' => :'String',
    :'id' => :'String',
    :'object' => :'String',
    :'payout_id' => :'String',
    :'transaction_id' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      commission_amount == o.commission_amount &&
      customer_id == o.customer_id &&
      id == o.id &&
      object == o.object &&
      payout_id == o.payout_id &&
      transaction_id == o.transaction_id &&
      uri == o.uri
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 238

def _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 = MfkOpenapiRubyClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 309

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 215

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


195
196
197
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



201
202
203
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 201

def hash
  [amount, commission_amount, customer_id, id, object, payout_id, transaction_id, uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



155
156
157
158
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



285
286
287
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 285

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 291

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

Returns:

  • (String) —

    String presentation of the object



279
280
281
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 279

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



162
163
164
165
166
 
# File 'lib/mfk_openapi_ruby_client/models/payout_refund.rb', line 162

def valid?
  object_validator = EnumAttributeValidator.new('String', ["payout_refund"])
  return false unless object_validator.valid?(@object)
  true
end