Class: UnivapayClientSdk::DirectDebitSchedule

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/univapay_client_sdk/models/direct_debit_schedule.rb

Overview

The key dates for one debit cycle. Use these to work out whether the current month's registration window is still open.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(merchant_bank_account_transfer_date: SKIP, merchant_bank_account_registration_deadline: SKIP, merchant_bank_transfer_upload_deadline: SKIP, platform_result_registration_date: SKIP, platform_scheduled_payout: SKIP, additional_properties: nil) ⇒ DirectDebitSchedule

Returns a new instance of DirectDebitSchedule.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 66

def initialize(merchant_bank_account_transfer_date: SKIP,
               merchant_bank_account_registration_deadline: SKIP,
               merchant_bank_transfer_upload_deadline: SKIP,
               platform_result_registration_date: SKIP,
               platform_scheduled_payout: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  unless  == SKIP
    @merchant_bank_account_transfer_date =
      
  end
  unless  == SKIP
    @merchant_bank_account_registration_deadline =
      
  end
  unless merchant_bank_transfer_upload_deadline == SKIP
    @merchant_bank_transfer_upload_deadline =
      merchant_bank_transfer_upload_deadline
  end
  unless platform_result_registration_date == SKIP
    @platform_result_registration_date =
      platform_result_registration_date
  end
  unless platform_scheduled_payout == SKIP
    @platform_scheduled_payout =
      platform_scheduled_payout
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#merchant_bank_account_registration_deadline ⇒ Date

The date by which the bank must receive the signed direct debit mandate (振替依頼書到着期限).

Returns:

  • (Date) 


20
21
22
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 20

def 
  @merchant_bank_account_registration_deadline
end

#merchant_bank_account_transfer_date ⇒ Date

The date funds are pulled from consumer accounts (指定振替日).

Returns:

  • (Date) 


15
16
17
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 15

def 
  @merchant_bank_account_transfer_date
end

#merchant_bank_transfer_upload_deadline ⇒ Date

The last date transfers can be registered or edited for this cycle (振替データアップロード期限). After this, transfers lock.

Returns:

  • (Date) 


25
26
27
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 25

def merchant_bank_transfer_upload_deadline
  @merchant_bank_transfer_upload_deadline
end

#platform_result_registration_date ⇒ Date

The date transfer results are reflected on the platform (振替結果反映日).

Returns:

  • (Date) 


29
30
31
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 29

def platform_result_registration_date
  @platform_result_registration_date
end

#platform_scheduled_payout ⇒ Date

The date collected funds are paid out to the merchant (支払日).

Returns:

  • (Date) 


33
34
35
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 33

def platform_scheduled_payout
  @platform_scheduled_payout
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



98
99
100
101
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
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 98

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
   =
    hash.key?('merchant_bank_account_transfer_date') ? hash['merchant_bank_account_transfer_date'] : SKIP
   =
    hash.key?('merchant_bank_account_registration_deadline') ? hash['merchant_bank_account_registration_deadline'] : SKIP
  merchant_bank_transfer_upload_deadline =
    hash.key?('merchant_bank_transfer_upload_deadline') ? hash['merchant_bank_transfer_upload_deadline'] : SKIP
  platform_result_registration_date =
    hash.key?('platform_result_registration_date') ? hash['platform_result_registration_date'] : SKIP
  platform_scheduled_payout =
    hash.key?('platform_scheduled_payout') ? hash['platform_scheduled_payout'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  DirectDebitSchedule.new(merchant_bank_account_transfer_date: ,
                          merchant_bank_account_registration_deadline: ,
                          merchant_bank_transfer_upload_deadline: merchant_bank_transfer_upload_deadline,
                          platform_result_registration_date: platform_result_registration_date,
                          platform_scheduled_payout: platform_scheduled_payout,
                          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 36

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['merchant_bank_account_transfer_date'] =
    'merchant_bank_account_transfer_date'
  @_hash['merchant_bank_account_registration_deadline'] =
    'merchant_bank_account_registration_deadline'
  @_hash['merchant_bank_transfer_upload_deadline'] =
    'merchant_bank_transfer_upload_deadline'
  @_hash['platform_result_registration_date'] =
    'platform_result_registration_date'
  @_hash['platform_scheduled_payout'] = 'platform_scheduled_payout'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



62
63
64
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 62

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



51
52
53
54
55
56
57
58
59
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 51

def self.optionals
  %w[
    merchant_bank_account_transfer_date
    merchant_bank_account_registration_deadline
    merchant_bank_transfer_upload_deadline
    platform_result_registration_date
    platform_scheduled_payout
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 141

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} merchant_bank_account_transfer_date:"\
  " #{@merchant_bank_account_transfer_date.inspect},"\
  ' merchant_bank_account_registration_deadline:'\
  " #{@merchant_bank_account_registration_deadline.inspect},"\
  ' merchant_bank_transfer_upload_deadline:'\
  " #{@merchant_bank_transfer_upload_deadline.inspect}, platform_result_registration_date:"\
  " #{@platform_result_registration_date.inspect}, platform_scheduled_payout:"\
  " #{@platform_scheduled_payout.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



130
131
132
133
134
135
136
137
138
 
# File 'lib/univapay_client_sdk/models/direct_debit_schedule.rb', line 130

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} merchant_bank_account_transfer_date:"\
  " #{@merchant_bank_account_transfer_date}, merchant_bank_account_registration_deadline:"\
  " #{@merchant_bank_account_registration_deadline}, merchant_bank_transfer_upload_deadline:"\
  " #{@merchant_bank_transfer_upload_deadline}, platform_result_registration_date:"\
  " #{@platform_result_registration_date}, platform_scheduled_payout:"\
  " #{@platform_scheduled_payout}, additional_properties: #{@additional_properties}>"
end