increase 1.362.0 → 1.364.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +8 -16
  4. data/lib/increase/models/account_number.rb +51 -81
  5. data/lib/increase/models/account_number_create_params.rb +41 -75
  6. data/lib/increase/models/account_number_list_params.rb +39 -39
  7. data/lib/increase/models/account_number_update_params.rb +48 -79
  8. data/lib/increase/models/ach_transfer.rb +38 -23
  9. data/lib/increase/models/card_payment.rb +6 -0
  10. data/lib/increase/models/card_update_params.rb +12 -8
  11. data/lib/increase/models/check_transfer.rb +58 -44
  12. data/lib/increase/models/check_transfer_create_params.rb +35 -21
  13. data/lib/increase/models/checkbook.rb +352 -0
  14. data/lib/increase/models/checkbook_check.rb +100 -0
  15. data/lib/increase/models/checkbook_check_list_params.rb +61 -0
  16. data/lib/increase/models/checkbook_check_retrieve_params.rb +22 -0
  17. data/lib/increase/models/checkbook_check_stop_params.rb +22 -0
  18. data/lib/increase/models/checkbook_create_params.rb +111 -0
  19. data/lib/increase/models/checkbook_list_params.rb +104 -0
  20. data/lib/increase/models/checkbook_retrieve_params.rb +22 -0
  21. data/lib/increase/models/checkbook_stop_params.rb +22 -0
  22. data/lib/increase/models/declined_transaction.rb +10 -1
  23. data/lib/increase/models/entity.rb +1 -65
  24. data/lib/increase/models/entity_create_params.rb +1 -65
  25. data/lib/increase/models/entity_update_params.rb +1 -57
  26. data/lib/increase/models/export.rb +12 -1
  27. data/lib/increase/models/export_create_params.rb +26 -4
  28. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  29. data/lib/increase/models/inbound_check_deposit.rb +12 -1
  30. data/lib/increase/models/inbound_real_time_payments_transfer.rb +10 -1
  31. data/lib/increase/models/inbound_real_time_payments_transfer_return_params.rb +36 -0
  32. data/lib/increase/models/real_time_decision.rb +65 -1
  33. data/lib/increase/models/real_time_payments_transfer.rb +21 -1
  34. data/lib/increase/models/simulations/checkbook_mail_params.rb +24 -0
  35. data/lib/increase/models/transaction.rb +27 -5
  36. data/lib/increase/models.rb +21 -20
  37. data/lib/increase/resources/account_numbers.rb +19 -16
  38. data/lib/increase/resources/checkbook_checks.rb +90 -0
  39. data/lib/increase/resources/checkbooks.rb +127 -0
  40. data/lib/increase/resources/entities.rb +2 -12
  41. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +28 -0
  42. data/lib/increase/resources/simulations/checkbooks.rb +38 -0
  43. data/lib/increase/resources/simulations.rb +4 -0
  44. data/lib/increase/version.rb +1 -1
  45. data/lib/increase.rb +14 -14
  46. data/rbi/increase/client.rbi +6 -12
  47. data/rbi/increase/models/account_number.rbi +86 -173
  48. data/rbi/increase/models/account_number_create_params.rbi +87 -165
  49. data/rbi/increase/models/account_number_list_params.rbi +106 -105
  50. data/rbi/increase/models/account_number_update_params.rbi +105 -190
  51. data/rbi/increase/models/ach_transfer.rbi +35 -23
  52. data/rbi/increase/models/card_payment.rbi +14 -0
  53. data/rbi/increase/models/card_update_params.rbi +17 -15
  54. data/rbi/increase/models/check_transfer.rbi +72 -54
  55. data/rbi/increase/models/check_transfer_create_params.rbi +55 -21
  56. data/rbi/increase/models/checkbook.rbi +507 -0
  57. data/rbi/increase/models/checkbook_check.rbi +142 -0
  58. data/rbi/increase/models/checkbook_check_list_params.rbi +96 -0
  59. data/rbi/increase/models/{oauth_connection_retrieve_params.rbi → checkbook_check_retrieve_params.rbi} +8 -8
  60. data/rbi/increase/models/{oauth_application_retrieve_params.rbi → checkbook_check_stop_params.rbi} +8 -11
  61. data/rbi/increase/models/checkbook_create_params.rbi +178 -0
  62. data/rbi/increase/models/checkbook_list_params.rbi +198 -0
  63. data/rbi/increase/models/checkbook_retrieve_params.rbi +40 -0
  64. data/rbi/increase/models/checkbook_stop_params.rbi +40 -0
  65. data/rbi/increase/models/declined_transaction.rbi +8 -0
  66. data/rbi/increase/models/entity.rbi +0 -97
  67. data/rbi/increase/models/entity_create_params.rbi +0 -119
  68. data/rbi/increase/models/entity_update_params.rbi +0 -108
  69. data/rbi/increase/models/export.rbi +15 -3
  70. data/rbi/increase/models/export_create_params.rbi +27 -3
  71. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  72. data/rbi/increase/models/inbound_check_deposit.rbi +10 -0
  73. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +8 -0
  74. data/rbi/increase/models/inbound_real_time_payments_transfer_return_params.rbi +61 -0
  75. data/rbi/increase/models/real_time_decision.rbi +134 -3
  76. data/rbi/increase/models/real_time_payments_transfer.rbi +18 -0
  77. data/rbi/increase/models/simulations/checkbook_mail_params.rbi +45 -0
  78. data/rbi/increase/models/transaction.rbi +33 -3
  79. data/rbi/increase/models.rbi +21 -22
  80. data/rbi/increase/resources/account_numbers.rbi +24 -19
  81. data/rbi/increase/resources/checkbook_checks.rbi +69 -0
  82. data/rbi/increase/resources/checkbooks.rbi +96 -0
  83. data/rbi/increase/resources/entities.rbi +0 -11
  84. data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +19 -0
  85. data/rbi/increase/resources/simulations/checkbooks.rbi +30 -0
  86. data/rbi/increase/resources/simulations.rbi +3 -0
  87. data/sig/increase/client.rbs +4 -8
  88. data/sig/increase/models/account_number.rbs +34 -66
  89. data/sig/increase/models/account_number_create_params.rbs +30 -64
  90. data/sig/increase/models/account_number_list_params.rbs +44 -44
  91. data/sig/increase/models/account_number_update_params.rbs +39 -77
  92. data/sig/increase/models/ach_transfer.rbs +4 -4
  93. data/sig/increase/models/card_payment.rbs +8 -0
  94. data/sig/increase/models/card_update_params.rbs +7 -11
  95. data/sig/increase/models/check_transfer.rbs +59 -49
  96. data/sig/increase/models/check_transfer_create_params.rbs +20 -12
  97. data/sig/increase/models/checkbook.rbs +272 -0
  98. data/sig/increase/models/checkbook_check.rbs +76 -0
  99. data/sig/increase/models/checkbook_check_list_params.rbs +56 -0
  100. data/sig/increase/models/{oauth_connection_retrieve_params.rbs → checkbook_check_retrieve_params.rbs} +6 -6
  101. data/sig/increase/models/{oauth_application_retrieve_params.rbs → checkbook_check_stop_params.rbs} +6 -6
  102. data/sig/increase/models/checkbook_create_params.rbs +90 -0
  103. data/sig/increase/models/checkbook_list_params.rbs +97 -0
  104. data/sig/increase/models/checkbook_retrieve_params.rbs +23 -0
  105. data/sig/increase/models/checkbook_stop_params.rbs +23 -0
  106. data/sig/increase/models/declined_transaction.rbs +5 -0
  107. data/sig/increase/models/entity.rbs +0 -46
  108. data/sig/increase/models/entity_create_params.rbs +0 -55
  109. data/sig/increase/models/entity_update_params.rbs +0 -48
  110. data/sig/increase/models/export.rbs +13 -3
  111. data/sig/increase/models/export_create_params.rbs +7 -0
  112. data/sig/increase/models/inbound_check_deposit.rbs +5 -0
  113. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +5 -0
  114. data/sig/increase/models/inbound_real_time_payments_transfer_return_params.rbs +30 -0
  115. data/sig/increase/models/real_time_decision.rbs +69 -3
  116. data/sig/increase/models/real_time_payments_transfer.rbs +10 -0
  117. data/sig/increase/models/simulations/checkbook_mail_params.rbs +25 -0
  118. data/sig/increase/models/transaction.rbs +26 -5
  119. data/sig/increase/models.rbs +20 -20
  120. data/sig/increase/resources/account_numbers.rbs +5 -5
  121. data/sig/increase/resources/checkbook_checks.rbs +26 -0
  122. data/sig/increase/resources/checkbooks.rbs +33 -0
  123. data/sig/increase/resources/entities.rbs +0 -3
  124. data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +6 -0
  125. data/sig/increase/resources/simulations/checkbooks.rbs +14 -0
  126. data/sig/increase/resources/simulations.rbs +2 -0
  127. metadata +45 -45
  128. data/lib/increase/models/group.rb +0 -57
  129. data/lib/increase/models/group_retrieve_params.rb +0 -14
  130. data/lib/increase/models/oauth_application.rb +0 -111
  131. data/lib/increase/models/oauth_application_list_params.rb +0 -129
  132. data/lib/increase/models/oauth_application_retrieve_params.rb +0 -22
  133. data/lib/increase/models/oauth_connection.rb +0 -107
  134. data/lib/increase/models/oauth_connection_list_params.rb +0 -88
  135. data/lib/increase/models/oauth_connection_retrieve_params.rb +0 -22
  136. data/lib/increase/models/oauth_token.rb +0 -76
  137. data/lib/increase/models/oauth_token_create_params.rb +0 -85
  138. data/lib/increase/resources/groups.rb +0 -32
  139. data/lib/increase/resources/oauth_applications.rb +0 -68
  140. data/lib/increase/resources/oauth_connections.rb +0 -70
  141. data/lib/increase/resources/oauth_tokens.rb +0 -54
  142. data/rbi/increase/models/group.rbi +0 -74
  143. data/rbi/increase/models/group_retrieve_params.rbi +0 -27
  144. data/rbi/increase/models/oauth_application.rbi +0 -146
  145. data/rbi/increase/models/oauth_application_list_params.rbi +0 -263
  146. data/rbi/increase/models/oauth_connection.rbi +0 -142
  147. data/rbi/increase/models/oauth_connection_list_params.rbi +0 -187
  148. data/rbi/increase/models/oauth_token.rbi +0 -106
  149. data/rbi/increase/models/oauth_token_create_params.rbi +0 -133
  150. data/rbi/increase/resources/groups.rbi +0 -21
  151. data/rbi/increase/resources/oauth_applications.rbi +0 -50
  152. data/rbi/increase/resources/oauth_connections.rbi +0 -52
  153. data/rbi/increase/resources/oauth_tokens.rbi +0 -44
  154. data/sig/increase/models/group.rbs +0 -36
  155. data/sig/increase/models/group_retrieve_params.rbs +0 -15
  156. data/sig/increase/models/oauth_application.rbs +0 -74
  157. data/sig/increase/models/oauth_application_list_params.rbs +0 -123
  158. data/sig/increase/models/oauth_connection.rbs +0 -74
  159. data/sig/increase/models/oauth_connection_list_params.rbs +0 -86
  160. data/sig/increase/models/oauth_token.rbs +0 -55
  161. data/sig/increase/models/oauth_token_create_params.rbs +0 -68
  162. data/sig/increase/resources/groups.rbs +0 -11
  163. data/sig/increase/resources/oauth_applications.rbs +0 -20
  164. data/sig/increase/resources/oauth_connections.rbs +0 -20
  165. data/sig/increase/resources/oauth_tokens.rbs +0 -16
@@ -13,18 +13,13 @@ module Increase
13
13
  # @return [String]
14
14
  required :account_number_id, String
15
15
 
16
- # @!attribute inbound_ach
17
- # Options related to how this Account Number handles inbound ACH transfers.
16
+ # @!attribute inbound_ach_debits
17
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
18
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
19
+ # active.
18
20
  #
19
- # @return [Increase::Models::AccountNumberUpdateParams::InboundACH, nil]
20
- optional :inbound_ach, -> { Increase::AccountNumberUpdateParams::InboundACH }
21
-
22
- # @!attribute inbound_checks
23
- # Options related to how this Account Number should handle inbound check
24
- # withdrawals.
25
- #
26
- # @return [Increase::Models::AccountNumberUpdateParams::InboundChecks, nil]
27
- optional :inbound_checks, -> { Increase::AccountNumberUpdateParams::InboundChecks }
21
+ # @return [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACHDebits, nil]
22
+ optional :inbound_ach_debits, enum: -> { Increase::AccountNumberUpdateParams::InboundACHDebits }
28
23
 
29
24
  # @!attribute name
30
25
  # The name you choose for the Account Number.
@@ -38,85 +33,45 @@ module Increase
38
33
  # @return [Symbol, Increase::Models::AccountNumberUpdateParams::Status, nil]
39
34
  optional :status, enum: -> { Increase::AccountNumberUpdateParams::Status }
40
35
 
41
- # @!method initialize(account_number_id:, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {})
42
- # @param account_number_id [String] The identifier of the Account Number.
36
+ # @!attribute unregistered_inbound_checks
37
+ # Whether unregistered inbound checks for this Account Number can be deposited.
43
38
  #
44
- # @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH]
45
- # Options related to how this Account Number handles inbound ACH transfers.
39
+ # @return [Symbol, Increase::Models::AccountNumberUpdateParams::UnregisteredInboundChecks, nil]
40
+ optional :unregistered_inbound_checks,
41
+ enum: -> { Increase::AccountNumberUpdateParams::UnregisteredInboundChecks }
42
+
43
+ # @!method initialize(account_number_id:, inbound_ach_debits: nil, name: nil, status: nil, unregistered_inbound_checks: nil, request_options: {})
44
+ # @param account_number_id [String] The identifier of the Account Number.
46
45
  #
47
- # @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks]
48
- # Options related to how this Account Number should handle inbound check
49
- # withdrawals.
46
+ # @param inbound_ach_debits [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACHDebits]
47
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
48
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
49
+ # active.
50
50
  #
51
51
  # @param name [String] The name you choose for the Account Number.
52
52
  #
53
53
  # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status]
54
54
  # This indicates if transfers can be made to the Account Number.
55
55
  #
56
+ # @param unregistered_inbound_checks [Symbol, Increase::Models::AccountNumberUpdateParams::UnregisteredInboundChecks]
57
+ # Whether unregistered inbound checks for this Account Number can be deposited.
58
+ #
56
59
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
57
60
 
58
- class InboundACH < Increase::Internal::Type::BaseModel
59
- # @!attribute debit_status
60
- # Whether ACH debits are allowed against this Account Number. Note that ACH debits
61
- # will be declined if this is `allowed` but the Account Number is not active.
62
- #
63
- # @return [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus, nil]
64
- optional :debit_status, enum: -> { Increase::AccountNumberUpdateParams::InboundACH::DebitStatus }
65
-
66
- # @!method initialize(debit_status: nil)
67
- # Options related to how this Account Number handles inbound ACH transfers.
68
- #
69
- # @param debit_status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundACH::DebitStatus]
70
- # Whether ACH debits are allowed against this Account Number. Note that ACH debits
71
- # will be declined if this is `allowed` but the Account Number is not active.
72
-
73
- # Whether ACH debits are allowed against this Account Number. Note that ACH debits
74
- # will be declined if this is `allowed` but the Account Number is not active.
75
- #
76
- # @see Increase::Models::AccountNumberUpdateParams::InboundACH#debit_status
77
- module DebitStatus
78
- extend Increase::Internal::Type::Enum
79
-
80
- # ACH Debits are allowed.
81
- ALLOWED = :allowed
82
-
83
- # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
84
- BLOCKED = :blocked
85
-
86
- # @!method self.values
87
- # @return [Array<Symbol>]
88
- end
89
- end
61
+ # Whether inbound ACH debits are allowed against this Account Number. Note that
62
+ # ACH debits will be declined if this is `allowed` but the Account Number is not
63
+ # active.
64
+ module InboundACHDebits
65
+ extend Increase::Internal::Type::Enum
66
+
67
+ # ACH Debits are allowed.
68
+ ALLOWED = :allowed
69
+
70
+ # ACH Debits are blocked. Received debits will be declined and returned with code `R20` (non-transaction account).
71
+ BLOCKED = :blocked
90
72
 
91
- class InboundChecks < Increase::Internal::Type::BaseModel
92
- # @!attribute status
93
- # How Increase should process checks with this account number printed on them.
94
- #
95
- # @return [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status]
96
- required :status, enum: -> { Increase::AccountNumberUpdateParams::InboundChecks::Status }
97
-
98
- # @!method initialize(status:)
99
- # Options related to how this Account Number should handle inbound check
100
- # withdrawals.
101
- #
102
- # @param status [Symbol, Increase::Models::AccountNumberUpdateParams::InboundChecks::Status]
103
- # How Increase should process checks with this account number printed on them.
104
-
105
- # How Increase should process checks with this account number printed on them.
106
- #
107
- # @see Increase::Models::AccountNumberUpdateParams::InboundChecks#status
108
- module Status
109
- extend Increase::Internal::Type::Enum
110
-
111
- # Checks with this Account Number will be processed even if they are not associated with a Check Transfer.
112
- ALLOWED = :allowed
113
-
114
- # Checks with this Account Number will be processed only if they can be matched to an existing Check Transfer.
115
- CHECK_TRANSFERS_ONLY = :check_transfers_only
116
-
117
- # @!method self.values
118
- # @return [Array<Symbol>]
119
- end
73
+ # @!method self.values
74
+ # @return [Array<Symbol>]
120
75
  end
121
76
 
122
77
  # This indicates if transfers can be made to the Account Number.
@@ -135,6 +90,20 @@ module Increase
135
90
  # @!method self.values
136
91
  # @return [Array<Symbol>]
137
92
  end
93
+
94
+ # Whether unregistered inbound checks for this Account Number can be deposited.
95
+ module UnregisteredInboundChecks
96
+ extend Increase::Internal::Type::Enum
97
+
98
+ # Accept all Inbound Check Deposits, even if they are not associated with a Check Transfer or Checkbook Check.
99
+ ALLOWED = :allowed
100
+
101
+ # Only accept Inbound Check Deposits if they can be matched to a Check Transfer or Checkbook Check.
102
+ BLOCKED = :blocked
103
+
104
+ # @!method self.values
105
+ # @return [Array<Symbol>]
106
+ end
138
107
  end
139
108
  end
140
109
  end
@@ -59,25 +59,34 @@ module Increase
59
59
  required :cancellation, -> { Increase::ACHTransfer::Cancellation }, nil?: true
60
60
 
61
61
  # @!attribute company_descriptive_date
62
- # The description of the date of the transfer.
62
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
63
+ # batch header. This value is informational and does not affect funds movement,
64
+ # settlement timing, or returns.
63
65
  #
64
66
  # @return [String, nil]
65
67
  required :company_descriptive_date, String, nil?: true
66
68
 
67
69
  # @!attribute company_discretionary_data
68
- # The data you chose to associate with the transfer.
70
+ # Custom data sent in the company batch header, meant as metadata for the
71
+ # originator. This value is informational and does not affect funds movement,
72
+ # settlement timing, or returns.
69
73
  #
70
74
  # @return [String, nil]
71
75
  required :company_discretionary_data, String, nil?: true
72
76
 
73
77
  # @!attribute company_entry_description
74
- # The description of the transfer you set to be shown to the recipient.
78
+ # A short description sent in the company batch header, meant to provide the
79
+ # receiver with a reason for the transfer. Many receivers do not surface this data
80
+ # on the receiver's bank statement.
75
81
  #
76
82
  # @return [String, nil]
77
83
  required :company_entry_description, String, nil?: true
78
84
 
79
85
  # @!attribute company_id
80
- # The company ID associated with the transfer.
86
+ # The Company ID sent in the batch header, which identifies the originator to the
87
+ # receiving bank. Businesses use this value to allowlist the companies permitted
88
+ # to debit their accounts. This value is configured by Increase and will be the
89
+ # same for all your transfers.
81
90
  #
82
91
  # @return [String]
83
92
  required :company_id, String
@@ -179,10 +188,8 @@ module Increase
179
188
  required :pending_transaction_id, String, nil?: true
180
189
 
181
190
  # @!attribute preferred_effective_date
182
- # Configuration for how the effective date of the transfer will be set. This
183
- # determines same-day vs future-dated settlement timing. If not set, defaults to a
184
- # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
185
- # must be set.
191
+ # Configuration for how the effective date of the transfer was set. This
192
+ # determines same-day vs future-dated settlement timing.
186
193
  #
187
194
  # @return [Increase::Models::ACHTransfer::PreferredEffectiveDate]
188
195
  required :preferred_effective_date, -> { Increase::ACHTransfer::PreferredEffectiveDate }
@@ -218,8 +225,8 @@ module Increase
218
225
  # @!attribute statement_descriptor
219
226
  # The descriptor that will show on the recipient's bank statement.
220
227
  #
221
- # @return [String]
222
- required :statement_descriptor, String
228
+ # @return [String, nil]
229
+ required :statement_descriptor, String, nil?: true
223
230
 
224
231
  # @!attribute status
225
232
  # The lifecycle status of the transfer.
@@ -281,14 +288,26 @@ module Increase
281
288
  # If your account requires approvals for transfers and the transfer was not
282
289
  # approved, this will contain details of the cancellation.
283
290
  #
284
- # @param company_descriptive_date [String, nil] The description of the date of the transfer.
291
+ # @param company_descriptive_date [String, nil]
292
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
293
+ # batch header. This value is informational and does not affect funds movement,
294
+ # settlement timing, or returns.
285
295
  #
286
- # @param company_discretionary_data [String, nil] The data you chose to associate with the transfer.
296
+ # @param company_discretionary_data [String, nil]
297
+ # Custom data sent in the company batch header, meant as metadata for the
298
+ # originator. This value is informational and does not affect funds movement,
299
+ # settlement timing, or returns.
287
300
  #
288
301
  # @param company_entry_description [String, nil]
289
- # The description of the transfer you set to be shown to the recipient.
302
+ # A short description sent in the company batch header, meant to provide the
303
+ # receiver with a reason for the transfer. Many receivers do not surface this data
304
+ # on the receiver's bank statement.
290
305
  #
291
- # @param company_id [String] The company ID associated with the transfer.
306
+ # @param company_id [String]
307
+ # The Company ID sent in the batch header, which identifies the originator to the
308
+ # receiving bank. Businesses use this value to allowlist the companies permitted
309
+ # to debit their accounts. This value is configured by Increase and will be the
310
+ # same for all your transfers.
292
311
  #
293
312
  # @param company_name [String, nil] The name by which the recipient knows you.
294
313
  #
@@ -341,10 +360,8 @@ module Increase
341
360
  # by someone else in your organization.
342
361
  #
343
362
  # @param preferred_effective_date [Increase::Models::ACHTransfer::PreferredEffectiveDate]
344
- # Configuration for how the effective date of the transfer will be set. This
345
- # determines same-day vs future-dated settlement timing. If not set, defaults to a
346
- # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
347
- # must be set.
363
+ # Configuration for how the effective date of the transfer was set. This
364
+ # determines same-day vs future-dated settlement timing.
348
365
  #
349
366
  # @param return_ [Increase::Models::ACHTransfer::Return, nil]
350
367
  # If your transfer is returned, this will contain details of the return.
@@ -362,7 +379,7 @@ module Increase
362
379
  # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
363
380
  # to use for the transfer.
364
381
  #
365
- # @param statement_descriptor [String] The descriptor that will show on the recipient's bank statement.
382
+ # @param statement_descriptor [String, nil] The descriptor that will show on the recipient's bank statement.
366
383
  #
367
384
  # @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer.
368
385
  #
@@ -1069,10 +1086,8 @@ module Increase
1069
1086
  nil?: true
1070
1087
 
1071
1088
  # @!method initialize(date:, settlement_schedule:)
1072
- # Configuration for how the effective date of the transfer will be set. This
1073
- # determines same-day vs future-dated settlement timing. If not set, defaults to a
1074
- # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
1075
- # must be set.
1089
+ # Configuration for how the effective date of the transfer was set. This
1090
+ # determines same-day vs future-dated settlement timing.
1076
1091
  #
1077
1092
  # @param date [Date, nil]
1078
1093
  # A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
@@ -10120,6 +10120,9 @@ module Increase
10120
10120
  # Electric vehicle charging level 3 480 volt
10121
10121
  ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT = :electric_vehicle_charging_level_3_480_volt
10122
10122
 
10123
+ # Diesel 1 off-road non-taxable
10124
+ DIESEL_1_OFF_ROAD_NON_TAXABLE = :diesel_1_off_road_non_taxable
10125
+
10123
10126
  # Renewable diesel R95 or greater off-road non-taxable
10124
10127
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
10125
10128
  :renewable_diesel_r95_or_greater_off_road_non_taxable
@@ -12859,6 +12862,9 @@ module Increase
12859
12862
  # Electric vehicle charging level 3 480 volt
12860
12863
  ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT = :electric_vehicle_charging_level_3_480_volt
12861
12864
 
12865
+ # Diesel 1 off-road non-taxable
12866
+ DIESEL_1_OFF_ROAD_NON_TAXABLE = :diesel_1_off_road_non_taxable
12867
+
12862
12868
  # Renewable diesel R95 or greater off-road non-taxable
12863
12869
  RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
12864
12870
  :renewable_diesel_r95_or_greater_off_road_non_taxable
@@ -533,18 +533,20 @@ module Increase
533
533
 
534
534
  # @!attribute email
535
535
  # An email address that can be used to verify the cardholder via one-time passcode
536
- # over email.
536
+ # over email. Send `null` to clear the email address. Omit this field to leave it
537
+ # unchanged.
537
538
  #
538
539
  # @return [String, nil]
539
- optional :email, String
540
+ optional :email, String, nil?: true
540
541
 
541
542
  # @!attribute phone
542
543
  # A phone number that can be used to verify the cardholder via one-time passcode
543
544
  # over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
544
- # `(415) 555-0123`.
545
+ # `(415) 555-0123`. Send `null` to clear the phone number. Omit this field to
546
+ # leave it unchanged.
545
547
  #
546
548
  # @return [String, nil]
547
- optional :phone, String
549
+ optional :phone, String, nil?: true
548
550
 
549
551
  # @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil)
550
552
  # The contact information used in the two-factor steps for digital wallet card
@@ -553,14 +555,16 @@ module Increase
553
555
  #
554
556
  # @param digital_card_profile_id [String] The digital card profile assigned to this digital card.
555
557
  #
556
- # @param email [String]
558
+ # @param email [String, nil]
557
559
  # An email address that can be used to verify the cardholder via one-time passcode
558
- # over email.
560
+ # over email. Send `null` to clear the email address. Omit this field to leave it
561
+ # unchanged.
559
562
  #
560
- # @param phone [String]
563
+ # @param phone [String, nil]
561
564
  # A phone number that can be used to verify the cardholder via one-time passcode
562
565
  # over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
563
- # `(415) 555-0123`.
566
+ # `(415) 555-0123`. Send `null` to clear the phone number. Omit this field to
567
+ # leave it unchanged.
564
568
  end
565
569
 
566
570
  # The status to update the Card with.
@@ -529,9 +529,16 @@ module Increase
529
529
  # @return [String, nil]
530
530
  required :note, String, nil?: true
531
531
 
532
+ # @!attribute payee
533
+ # The payee of the check. This will be printed in the Pay to the Order Of portion
534
+ # of the check.
535
+ #
536
+ # @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payee>]
537
+ required :payee, -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payee] }
538
+
532
539
  # @!attribute payer
533
540
  # The payer of the check. This will be printed on the top-left portion of the
534
- # check and defaults to the return address if unspecified.
541
+ # check.
535
542
  #
536
543
  # @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>]
537
544
  required :payer, -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payer] }
@@ -542,17 +549,11 @@ module Increase
542
549
  # @return [String, nil]
543
550
  required :physical_check_batch_id, String, nil?: true
544
551
 
545
- # @!attribute recipient_name
546
- # The name that will be printed on the check.
547
- #
548
- # @return [String]
549
- required :recipient_name, String
550
-
551
552
  # @!attribute return_address
552
553
  # The return address to be printed on the check.
553
554
  #
554
- # @return [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil]
555
- required :return_address, -> { Increase::CheckTransfer::PhysicalCheck::ReturnAddress }, nil?: true
555
+ # @return [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress]
556
+ required :return_address, -> { Increase::CheckTransfer::PhysicalCheck::ReturnAddress }
556
557
 
557
558
  # @!attribute return_address_name
558
559
  # A custom name printed above the Increase-managed return address.
@@ -580,7 +581,7 @@ module Increase
580
581
  required :tracking_updates,
581
582
  -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate] }
582
583
 
583
- # @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, physical_check_batch_id:, recipient_name:, return_address:, return_address_name:, shipping_method:, signature:, tracking_updates:)
584
+ # @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payee:, payer:, physical_check_batch_id:, return_address:, return_address_name:, shipping_method:, signature:, tracking_updates:)
584
585
  # Details relating to the physical check that Increase will print and mail. Will
585
586
  # be present if and only if `fulfillment_method` is equal to `physical_check`.
586
587
  #
@@ -595,16 +596,18 @@ module Increase
595
596
  #
596
597
  # @param note [String, nil] The descriptor that will be printed on the letter included with the check.
597
598
  #
599
+ # @param payee [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payee>]
600
+ # The payee of the check. This will be printed in the Pay to the Order Of portion
601
+ # of the check.
602
+ #
598
603
  # @param payer [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>]
599
604
  # The payer of the check. This will be printed on the top-left portion of the
600
- # check and defaults to the return address if unspecified.
605
+ # check.
601
606
  #
602
607
  # @param physical_check_batch_id [String, nil]
603
608
  # The identifier of the Physical Check Batch that this check is a part of.
604
609
  #
605
- # @param recipient_name [String] The name that will be printed on the check.
606
- #
607
- # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil]
610
+ # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress]
608
611
  # The return address to be printed on the check.
609
612
  #
610
613
  # @param return_address_name [String, nil] A custom name printed above the Increase-managed return address.
@@ -624,14 +627,14 @@ module Increase
624
627
  # @!attribute city
625
628
  # The city of the check's destination.
626
629
  #
627
- # @return [String, nil]
628
- required :city, String, nil?: true
630
+ # @return [String]
631
+ required :city, String
629
632
 
630
633
  # @!attribute line1
631
634
  # The street address of the check's destination.
632
635
  #
633
- # @return [String, nil]
634
- required :line1, String, nil?: true
636
+ # @return [String]
637
+ required :line1, String
635
638
 
636
639
  # @!attribute line2
637
640
  # The second line of the address of the check's destination.
@@ -642,8 +645,8 @@ module Increase
642
645
  # @!attribute name
643
646
  # The name component of the check's mailing address.
644
647
  #
645
- # @return [String, nil]
646
- required :name, String, nil?: true
648
+ # @return [String]
649
+ required :name, String
647
650
 
648
651
  # @!attribute phone
649
652
  # The phone number to be used in case of delivery issues at the check's mailing
@@ -655,33 +658,44 @@ module Increase
655
658
  # @!attribute postal_code
656
659
  # The postal code of the check's destination.
657
660
  #
658
- # @return [String, nil]
659
- required :postal_code, String, nil?: true
661
+ # @return [String]
662
+ required :postal_code, String
660
663
 
661
664
  # @!attribute state
662
665
  # The state of the check's destination.
663
666
  #
664
- # @return [String, nil]
665
- required :state, String, nil?: true
667
+ # @return [String]
668
+ required :state, String
666
669
 
667
670
  # @!method initialize(city:, line1:, line2:, name:, phone:, postal_code:, state:)
668
671
  # Details for where Increase will mail the check.
669
672
  #
670
- # @param city [String, nil] The city of the check's destination.
673
+ # @param city [String] The city of the check's destination.
671
674
  #
672
- # @param line1 [String, nil] The street address of the check's destination.
675
+ # @param line1 [String] The street address of the check's destination.
673
676
  #
674
677
  # @param line2 [String, nil] The second line of the address of the check's destination.
675
678
  #
676
- # @param name [String, nil] The name component of the check's mailing address.
679
+ # @param name [String] The name component of the check's mailing address.
677
680
  #
678
681
  # @param phone [String, nil]
679
682
  # The phone number to be used in case of delivery issues at the check's mailing
680
683
  # address. Only used for FedEx overnight shipping.
681
684
  #
682
- # @param postal_code [String, nil] The postal code of the check's destination.
685
+ # @param postal_code [String] The postal code of the check's destination.
686
+ #
687
+ # @param state [String] The state of the check's destination.
688
+ end
689
+
690
+ class Payee < Increase::Internal::Type::BaseModel
691
+ # @!attribute contents
692
+ # The contents of the line.
683
693
  #
684
- # @param state [String, nil] The state of the check's destination.
694
+ # @return [String]
695
+ required :contents, String
696
+
697
+ # @!method initialize(contents:)
698
+ # @param contents [String] The contents of the line.
685
699
  end
686
700
 
687
701
  class Payer < Increase::Internal::Type::BaseModel
@@ -700,14 +714,14 @@ module Increase
700
714
  # @!attribute city
701
715
  # The city of the check's destination.
702
716
  #
703
- # @return [String, nil]
704
- required :city, String, nil?: true
717
+ # @return [String]
718
+ required :city, String
705
719
 
706
720
  # @!attribute line1
707
721
  # The street address of the check's destination.
708
722
  #
709
- # @return [String, nil]
710
- required :line1, String, nil?: true
723
+ # @return [String]
724
+ required :line1, String
711
725
 
712
726
  # @!attribute line2
713
727
  # The second line of the address of the check's destination.
@@ -718,8 +732,8 @@ module Increase
718
732
  # @!attribute name
719
733
  # The name component of the check's return address.
720
734
  #
721
- # @return [String, nil]
722
- required :name, String, nil?: true
735
+ # @return [String]
736
+ required :name, String
723
737
 
724
738
  # @!attribute phone
725
739
  # The shipper's phone number to be used in case of delivery issues. Only used for
@@ -731,33 +745,33 @@ module Increase
731
745
  # @!attribute postal_code
732
746
  # The postal code of the check's destination.
733
747
  #
734
- # @return [String, nil]
735
- required :postal_code, String, nil?: true
748
+ # @return [String]
749
+ required :postal_code, String
736
750
 
737
751
  # @!attribute state
738
752
  # The state of the check's destination.
739
753
  #
740
- # @return [String, nil]
741
- required :state, String, nil?: true
754
+ # @return [String]
755
+ required :state, String
742
756
 
743
757
  # @!method initialize(city:, line1:, line2:, name:, phone:, postal_code:, state:)
744
758
  # The return address to be printed on the check.
745
759
  #
746
- # @param city [String, nil] The city of the check's destination.
760
+ # @param city [String] The city of the check's destination.
747
761
  #
748
- # @param line1 [String, nil] The street address of the check's destination.
762
+ # @param line1 [String] The street address of the check's destination.
749
763
  #
750
764
  # @param line2 [String, nil] The second line of the address of the check's destination.
751
765
  #
752
- # @param name [String, nil] The name component of the check's return address.
766
+ # @param name [String] The name component of the check's return address.
753
767
  #
754
768
  # @param phone [String, nil]
755
769
  # The shipper's phone number to be used in case of delivery issues. Only used for
756
770
  # FedEx overnight shipping.
757
771
  #
758
- # @param postal_code [String, nil] The postal code of the check's destination.
772
+ # @param postal_code [String] The postal code of the check's destination.
759
773
  #
760
- # @param state [String, nil] The state of the check's destination.
774
+ # @param state [String] The state of the check's destination.
761
775
  end
762
776
 
763
777
  # The shipping method for the check.