Class: MfkOpenapiRubyClient::Payout

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

Overview

Money Forward Kessaiから売り手様への金額確定済みの振込です。

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Payout

Initializes the object



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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 117

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

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

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

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

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  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.rb', line 20

def amount
  @amount
end

#collected_amount ⇒ Object

振込の対象となる回収金額です。



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

def collected_amount
  @collected_amount
end

#deduction ⇒ Object

Returns the value of attribute deduction.



25
26
27
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 25

def deduction
  @deduction
end

#id ⇒ Object

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



28
29
30
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 28

def id
  @id
end

#object ⇒ Object

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



31
32
33
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 31

def object
  @object
end

#payout_date ⇒ Object

振込予定日です。



34
35
36
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 34

def payout_date
  @payout_date
end

#receivables_amount ⇒ Object

振込の対象となる債権金額です。



37
38
39
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 37

def receivables_amount
  @receivables_amount
end

#status ⇒ Object

振込ステータスです。振込手続中(‘in_progress`)、振込完了(`completed`)があります。



40
41
42
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 40

def status
  @status
end

#type ⇒ Object

振込種別です。通常振込(‘normal`)、早期振込(`early`)があります。



43
44
45
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 43

def type
  @type
end

#uri ⇒ Object

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



46
47
48
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 46

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 87

def self.acceptable_attributes
  attribute_map.values
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
84
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 71

def self.attribute_map
  {
    :'amount' => :'amount',
    :'collected_amount' => :'collected_amount',
    :'deduction' => :'deduction',
    :'id' => :'id',
    :'object' => :'object',
    :'payout_date' => :'payout_date',
    :'receivables_amount' => :'receivables_amount',
    :'status' => :'status',
    :'type' => :'type',
    :'uri' => :'uri'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



252
253
254
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 252

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
113
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 92

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'collected_amount' => :'Integer',
    :'deduction' => :'Deduction',
    :'id' => :'String',
    :'object' => :'String',
    :'payout_date' => :'Date',
    :'receivables_amount' => :'Integer',
    :'status' => :'String',
    :'type' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      collected_amount == o.collected_amount &&
      deduction == o.deduction &&
      id == o.id &&
      object == o.object &&
      payout_date == o.payout_date &&
      receivables_amount == o.receivables_amount &&
      status == o.status &&
      type == o.type &&
      uri == o.uri
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 282

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 353

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 259

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

See Also:

  • `==` method


239
240
241
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



245
246
247
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 245

def hash
  [amount, collected_amount, deduction, id, object, payout_date, receivables_amount, status, type, uri].hash
end

#list_invalid_properties ⇒ Object

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



173
174
175
176
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 173

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



329
330
331
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 329

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 335

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



323
324
325
 
# File 'lib/mfk_openapi_ruby_client/models/payout.rb', line 323

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



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

def valid?
  object_validator = EnumAttributeValidator.new('String', ["payout"])
  return false unless object_validator.valid?(@object)
  status_validator = EnumAttributeValidator.new('String', ["in_progress", "completed"])
  return false unless status_validator.valid?(@status)
  type_validator = EnumAttributeValidator.new('String', ["normal", "early"])
  return false unless type_validator.valid?(@type)
  true
end