increase 1.362.0 → 1.363.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 (83) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +0 -16
  4. data/lib/increase/models/ach_transfer.rb +38 -23
  5. data/lib/increase/models/check_transfer.rb +58 -44
  6. data/lib/increase/models/check_transfer_create_params.rb +35 -21
  7. data/lib/increase/models/export.rb +12 -1
  8. data/lib/increase/models/export_create_params.rb +26 -4
  9. data/lib/increase/models/inbound_real_time_payments_transfer.rb +10 -1
  10. data/lib/increase/models/inbound_real_time_payments_transfer_return_params.rb +36 -0
  11. data/lib/increase/models/real_time_payments_transfer.rb +21 -1
  12. data/lib/increase/models/transaction.rb +3 -3
  13. data/lib/increase/models.rb +3 -20
  14. data/lib/increase/resources/inbound_real_time_payments_transfers.rb +28 -0
  15. data/lib/increase/version.rb +1 -1
  16. data/lib/increase.rb +1 -14
  17. data/rbi/increase/client.rbi +0 -12
  18. data/rbi/increase/models/ach_transfer.rbi +35 -23
  19. data/rbi/increase/models/check_transfer.rbi +72 -54
  20. data/rbi/increase/models/check_transfer_create_params.rbi +55 -21
  21. data/rbi/increase/models/export.rbi +15 -3
  22. data/rbi/increase/models/export_create_params.rbi +27 -3
  23. data/rbi/increase/models/inbound_real_time_payments_transfer.rbi +8 -0
  24. data/rbi/increase/models/inbound_real_time_payments_transfer_return_params.rbi +61 -0
  25. data/rbi/increase/models/real_time_payments_transfer.rbi +18 -0
  26. data/rbi/increase/models/transaction.rbi +3 -3
  27. data/rbi/increase/models.rbi +3 -22
  28. data/rbi/increase/resources/inbound_real_time_payments_transfers.rbi +19 -0
  29. data/sig/increase/client.rbs +0 -8
  30. data/sig/increase/models/ach_transfer.rbs +4 -4
  31. data/sig/increase/models/check_transfer.rbs +59 -49
  32. data/sig/increase/models/check_transfer_create_params.rbs +20 -12
  33. data/sig/increase/models/export.rbs +13 -3
  34. data/sig/increase/models/export_create_params.rbs +7 -0
  35. data/sig/increase/models/inbound_real_time_payments_transfer.rbs +5 -0
  36. data/sig/increase/models/inbound_real_time_payments_transfer_return_params.rbs +30 -0
  37. data/sig/increase/models/real_time_payments_transfer.rbs +10 -0
  38. data/sig/increase/models/transaction.rbs +4 -4
  39. data/sig/increase/models.rbs +2 -20
  40. data/sig/increase/resources/inbound_real_time_payments_transfers.rbs +6 -0
  41. metadata +6 -45
  42. data/lib/increase/models/group.rb +0 -57
  43. data/lib/increase/models/group_retrieve_params.rb +0 -14
  44. data/lib/increase/models/oauth_application.rb +0 -111
  45. data/lib/increase/models/oauth_application_list_params.rb +0 -129
  46. data/lib/increase/models/oauth_application_retrieve_params.rb +0 -22
  47. data/lib/increase/models/oauth_connection.rb +0 -107
  48. data/lib/increase/models/oauth_connection_list_params.rb +0 -88
  49. data/lib/increase/models/oauth_connection_retrieve_params.rb +0 -22
  50. data/lib/increase/models/oauth_token.rb +0 -76
  51. data/lib/increase/models/oauth_token_create_params.rb +0 -85
  52. data/lib/increase/resources/groups.rb +0 -32
  53. data/lib/increase/resources/oauth_applications.rb +0 -68
  54. data/lib/increase/resources/oauth_connections.rb +0 -70
  55. data/lib/increase/resources/oauth_tokens.rb +0 -54
  56. data/rbi/increase/models/group.rbi +0 -74
  57. data/rbi/increase/models/group_retrieve_params.rbi +0 -27
  58. data/rbi/increase/models/oauth_application.rbi +0 -146
  59. data/rbi/increase/models/oauth_application_list_params.rbi +0 -263
  60. data/rbi/increase/models/oauth_application_retrieve_params.rbi +0 -46
  61. data/rbi/increase/models/oauth_connection.rbi +0 -142
  62. data/rbi/increase/models/oauth_connection_list_params.rbi +0 -187
  63. data/rbi/increase/models/oauth_connection_retrieve_params.rbi +0 -46
  64. data/rbi/increase/models/oauth_token.rbi +0 -106
  65. data/rbi/increase/models/oauth_token_create_params.rbi +0 -133
  66. data/rbi/increase/resources/groups.rbi +0 -21
  67. data/rbi/increase/resources/oauth_applications.rbi +0 -50
  68. data/rbi/increase/resources/oauth_connections.rbi +0 -52
  69. data/rbi/increase/resources/oauth_tokens.rbi +0 -44
  70. data/sig/increase/models/group.rbs +0 -36
  71. data/sig/increase/models/group_retrieve_params.rbs +0 -15
  72. data/sig/increase/models/oauth_application.rbs +0 -74
  73. data/sig/increase/models/oauth_application_list_params.rbs +0 -123
  74. data/sig/increase/models/oauth_application_retrieve_params.rbs +0 -24
  75. data/sig/increase/models/oauth_connection.rbs +0 -74
  76. data/sig/increase/models/oauth_connection_list_params.rbs +0 -86
  77. data/sig/increase/models/oauth_connection_retrieve_params.rbs +0 -24
  78. data/sig/increase/models/oauth_token.rbs +0 -55
  79. data/sig/increase/models/oauth_token_create_params.rbs +0 -68
  80. data/sig/increase/resources/groups.rbs +0 -11
  81. data/sig/increase/resources/oauth_applications.rbs +0 -20
  82. data/sig/increase/resources/oauth_connections.rbs +0 -20
  83. data/sig/increase/resources/oauth_tokens.rbs +0 -16
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::InboundRealTimePaymentsTransfers#return_
6
+ class InboundRealTimePaymentsTransferReturnParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute inbound_real_time_payments_transfer_id
11
+ # The identifier of the Inbound Real-Time Payments Transfer to return to its
12
+ # sender.
13
+ #
14
+ # @return [String]
15
+ required :inbound_real_time_payments_transfer_id, String
16
+
17
+ # @!attribute amount
18
+ # The amount to return, in USD cents. Defaults to the full amount of the Inbound
19
+ # Real-Time Payments Transfer, and can't be higher than it.
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :amount, Integer
23
+
24
+ # @!method initialize(inbound_real_time_payments_transfer_id:, amount: nil, request_options: {})
25
+ # @param inbound_real_time_payments_transfer_id [String]
26
+ # The identifier of the Inbound Real-Time Payments Transfer to return to its
27
+ # sender.
28
+ #
29
+ # @param amount [Integer]
30
+ # The amount to return, in USD cents. Defaults to the full amount of the Inbound
31
+ # Real-Time Payments Transfer, and can't be higher than it.
32
+ #
33
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
34
+ end
35
+ end
36
+ end
@@ -83,6 +83,12 @@ module Increase
83
83
  # @return [String, nil]
84
84
  required :debtor_name, String, nil?: true
85
85
 
86
+ # @!attribute end_to_end_identification
87
+ # A free-form reference string set by the sender, to help identify the transfer.
88
+ #
89
+ # @return [String, nil]
90
+ required :end_to_end_identification, String, nil?: true
91
+
86
92
  # @!attribute external_account_id
87
93
  # The identifier of the External Account the transfer was made to, if any.
88
94
  #
@@ -120,6 +126,13 @@ module Increase
120
126
  # @return [Increase::Models::RealTimePaymentsTransfer::Rejection, nil]
121
127
  required :rejection, -> { Increase::RealTimePaymentsTransfer::Rejection }, nil?: true
122
128
 
129
+ # @!attribute return_of_inbound_real_time_payments_transfer_id
130
+ # The identifier of the Inbound Real-Time Payments Transfer this transfer returns,
131
+ # if any.
132
+ #
133
+ # @return [String, nil]
134
+ required :return_of_inbound_real_time_payments_transfer_id, String, nil?: true
135
+
123
136
  # @!attribute routing_number
124
137
  # The destination American Bankers' Association (ABA) Routing Transit Number
125
138
  # (RTN).
@@ -179,7 +192,7 @@ module Increase
179
192
  # @return [String]
180
193
  required :unstructured_remittance_information, String
181
194
 
182
- # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, external_account_id:, idempotency_key:, inbound_real_time_payments_request_for_payment_id:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
195
+ # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, approval:, cancellation:, created_at:, created_by:, creditor_name:, currency:, debtor_name:, end_to_end_identification:, external_account_id:, idempotency_key:, inbound_real_time_payments_request_for_payment_id:, pending_transaction_id:, rejection:, return_of_inbound_real_time_payments_transfer_id:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, ultimate_creditor_name:, ultimate_debtor_name:, unstructured_remittance_information:)
183
196
  # Real-Time Payments transfers move funds, within seconds, between your Increase
184
197
  # account and any other account on the Real-Time Payments network.
185
198
  #
@@ -222,6 +235,9 @@ module Increase
222
235
  # The name of the transfer's sender. If not provided, defaults to the name of the
223
236
  # account's entity.
224
237
  #
238
+ # @param end_to_end_identification [String, nil]
239
+ # A free-form reference string set by the sender, to help identify the transfer.
240
+ #
225
241
  # @param external_account_id [String, nil]
226
242
  # The identifier of the External Account the transfer was made to, if any.
227
243
  #
@@ -244,6 +260,10 @@ module Increase
244
260
  # If the transfer is rejected by Real-Time Payments or the destination financial
245
261
  # institution, this will contain supplemental details.
246
262
  #
263
+ # @param return_of_inbound_real_time_payments_transfer_id [String, nil]
264
+ # The identifier of the Inbound Real-Time Payments Transfer this transfer returns,
265
+ # if any.
266
+ #
247
267
  # @param routing_number [String]
248
268
  # The destination American Bankers' Association (ABA) Routing Transit Number
249
269
  # (RTN).
@@ -1129,8 +1129,8 @@ module Increase
1129
1129
  # @!attribute statement_descriptor
1130
1130
  # A description set when the ACH Transfer was created.
1131
1131
  #
1132
- # @return [String]
1133
- required :statement_descriptor, String
1132
+ # @return [String, nil]
1133
+ required :statement_descriptor, String, nil?: true
1134
1134
 
1135
1135
  # @!attribute transfer_id
1136
1136
  # The identifier of the ACH Transfer that led to this Transaction.
@@ -1154,7 +1154,7 @@ module Increase
1154
1154
  # The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
1155
1155
  # destination account.
1156
1156
  #
1157
- # @param statement_descriptor [String] A description set when the ACH Transfer was created.
1157
+ # @param statement_descriptor [String, nil] A description set when the ACH Transfer was created.
1158
1158
  #
1159
1159
  # @param transfer_id [String] The identifier of the ACH Transfer that led to this Transaction.
1160
1160
  end
@@ -335,10 +335,6 @@ module Increase
335
335
 
336
336
  FileRetrieveParams = Increase::Models::FileRetrieveParams
337
337
 
338
- Group = Increase::Models::Group
339
-
340
- GroupRetrieveParams = Increase::Models::GroupRetrieveParams
341
-
342
338
  InboundACHTransfer = Increase::Models::InboundACHTransfer
343
339
 
344
340
  InboundACHTransferCreateNotificationOfChangeParams =
@@ -391,6 +387,9 @@ module Increase
391
387
  InboundRealTimePaymentsTransferRetrieveParams =
392
388
  Increase::Models::InboundRealTimePaymentsTransferRetrieveParams
393
389
 
390
+ InboundRealTimePaymentsTransferReturnParams =
391
+ Increase::Models::InboundRealTimePaymentsTransferReturnParams
392
+
394
393
  InboundWireDrawdownRequest = Increase::Models::InboundWireDrawdownRequest
395
394
 
396
395
  InboundWireDrawdownRequestListParams = Increase::Models::InboundWireDrawdownRequestListParams
@@ -449,22 +448,6 @@ module Increase
449
448
 
450
449
  LockboxRecipientUpdateParams = Increase::Models::LockboxRecipientUpdateParams
451
450
 
452
- OAuthApplication = Increase::Models::OAuthApplication
453
-
454
- OAuthApplicationListParams = Increase::Models::OAuthApplicationListParams
455
-
456
- OAuthApplicationRetrieveParams = Increase::Models::OAuthApplicationRetrieveParams
457
-
458
- OAuthConnection = Increase::Models::OAuthConnection
459
-
460
- OAuthConnectionListParams = Increase::Models::OAuthConnectionListParams
461
-
462
- OAuthConnectionRetrieveParams = Increase::Models::OAuthConnectionRetrieveParams
463
-
464
- OAuthToken = Increase::Models::OAuthToken
465
-
466
- OAuthTokenCreateParams = Increase::Models::OAuthTokenCreateParams
467
-
468
451
  PendingTransaction = Increase::Models::PendingTransaction
469
452
 
470
453
  PendingTransactionCreateParams = Increase::Models::PendingTransactionCreateParams
@@ -64,6 +64,34 @@ module Increase
64
64
  )
65
65
  end
66
66
 
67
+ # Return an Inbound Real-Time Payments Transfer
68
+ #
69
+ # @overload return_(inbound_real_time_payments_transfer_id, amount: nil, request_options: {})
70
+ #
71
+ # @param inbound_real_time_payments_transfer_id [String]
72
+ # The identifier of the Inbound Real-Time Payments Transfer to return to its
73
+ # sender.
74
+ #
75
+ # @param amount [Integer]
76
+ # The amount to return, in USD cents. Defaults to the full amount of the Inbound
77
+ # Real-Time Payments Transfer, and can't be higher than it.
78
+ #
79
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
80
+ #
81
+ # @return [Increase::Models::RealTimePaymentsTransfer]
82
+ #
83
+ # @see Increase::Models::InboundRealTimePaymentsTransferReturnParams
84
+ def return_(inbound_real_time_payments_transfer_id, params = {})
85
+ parsed, options = Increase::InboundRealTimePaymentsTransferReturnParams.dump_request(params)
86
+ @client.request(
87
+ method: :post,
88
+ path: ["inbound_real_time_payments_transfers/%1$s/return", inbound_real_time_payments_transfer_id],
89
+ body: parsed,
90
+ model: Increase::RealTimePaymentsTransfer,
91
+ options: options
92
+ )
93
+ end
94
+
67
95
  # @api private
68
96
  #
69
97
  # @param client [Increase::Client]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.362.0"
4
+ VERSION = "1.363.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -202,8 +202,6 @@ require_relative "increase/models/file_link"
202
202
  require_relative "increase/models/file_link_create_params"
203
203
  require_relative "increase/models/file_list_params"
204
204
  require_relative "increase/models/file_retrieve_params"
205
- require_relative "increase/models/group"
206
- require_relative "increase/models/group_retrieve_params"
207
205
  require_relative "increase/models/inbound_ach_transfer"
208
206
  require_relative "increase/models/inbound_ach_transfer_create_notification_of_change_params"
209
207
  require_relative "increase/models/inbound_ach_transfer_decline_params"
@@ -228,6 +226,7 @@ require_relative "increase/models/inbound_real_time_payments_requests_for_paymen
228
226
  require_relative "increase/models/inbound_real_time_payments_transfer"
229
227
  require_relative "increase/models/inbound_real_time_payments_transfer_list_params"
230
228
  require_relative "increase/models/inbound_real_time_payments_transfer_retrieve_params"
229
+ require_relative "increase/models/inbound_real_time_payments_transfer_return_params"
231
230
  require_relative "increase/models/inbound_wire_drawdown_request"
232
231
  require_relative "increase/models/inbound_wire_drawdown_request_list_params"
233
232
  require_relative "increase/models/inbound_wire_drawdown_request_retrieve_params"
@@ -257,14 +256,6 @@ require_relative "increase/models/lockbox_recipient_create_params"
257
256
  require_relative "increase/models/lockbox_recipient_list_params"
258
257
  require_relative "increase/models/lockbox_recipient_retrieve_params"
259
258
  require_relative "increase/models/lockbox_recipient_update_params"
260
- require_relative "increase/models/oauth_application"
261
- require_relative "increase/models/oauth_application_list_params"
262
- require_relative "increase/models/oauth_application_retrieve_params"
263
- require_relative "increase/models/oauth_connection"
264
- require_relative "increase/models/oauth_connection_list_params"
265
- require_relative "increase/models/oauth_connection_retrieve_params"
266
- require_relative "increase/models/oauth_token"
267
- require_relative "increase/models/oauth_token_create_params"
268
259
  require_relative "increase/models/pending_transaction"
269
260
  require_relative "increase/models/pending_transaction_create_params"
270
261
  require_relative "increase/models/pending_transaction_list_params"
@@ -408,7 +399,6 @@ require_relative "increase/resources/external_accounts"
408
399
  require_relative "increase/resources/fednow_transfers"
409
400
  require_relative "increase/resources/file_links"
410
401
  require_relative "increase/resources/files"
411
- require_relative "increase/resources/groups"
412
402
  require_relative "increase/resources/inbound_ach_transfers"
413
403
  require_relative "increase/resources/inbound_check_deposits"
414
404
  require_relative "increase/resources/inbound_fednow_transfers"
@@ -422,9 +412,6 @@ require_relative "increase/resources/intrafi_balances"
422
412
  require_relative "increase/resources/intrafi_exclusions"
423
413
  require_relative "increase/resources/lockbox_addresses"
424
414
  require_relative "increase/resources/lockbox_recipients"
425
- require_relative "increase/resources/oauth_applications"
426
- require_relative "increase/resources/oauth_connections"
427
- require_relative "increase/resources/oauth_tokens"
428
415
  require_relative "increase/resources/pending_transactions"
429
416
  require_relative "increase/resources/physical_card_profiles"
430
417
  require_relative "increase/resources/physical_cards"
@@ -174,18 +174,6 @@ module Increase
174
174
  sig { returns(Increase::Resources::RealTimeDecisions) }
175
175
  attr_reader :real_time_decisions
176
176
 
177
- sig { returns(Increase::Resources::Groups) }
178
- attr_reader :groups
179
-
180
- sig { returns(Increase::Resources::OAuthApplications) }
181
- attr_reader :oauth_applications
182
-
183
- sig { returns(Increase::Resources::OAuthConnections) }
184
- attr_reader :oauth_connections
185
-
186
- sig { returns(Increase::Resources::OAuthTokens) }
187
- attr_reader :oauth_tokens
188
-
189
177
  sig { returns(Increase::Resources::IntrafiAccountEnrollments) }
190
178
  attr_reader :intrafi_account_enrollments
191
179
 
@@ -73,19 +73,28 @@ module Increase
73
73
  end
74
74
  attr_writer :cancellation
75
75
 
76
- # The description of the date of the transfer.
76
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
77
+ # batch header. This value is informational and does not affect funds movement,
78
+ # settlement timing, or returns.
77
79
  sig { returns(T.nilable(String)) }
78
80
  attr_accessor :company_descriptive_date
79
81
 
80
- # The data you chose to associate with the transfer.
82
+ # Custom data sent in the company batch header, meant as metadata for the
83
+ # originator. This value is informational and does not affect funds movement,
84
+ # settlement timing, or returns.
81
85
  sig { returns(T.nilable(String)) }
82
86
  attr_accessor :company_discretionary_data
83
87
 
84
- # The description of the transfer you set to be shown to the recipient.
88
+ # A short description sent in the company batch header, meant to provide the
89
+ # receiver with a reason for the transfer. Many receivers do not surface this data
90
+ # on the receiver's bank statement.
85
91
  sig { returns(T.nilable(String)) }
86
92
  attr_accessor :company_entry_description
87
93
 
88
- # The company ID associated with the transfer.
94
+ # The Company ID sent in the batch header, which identifies the originator to the
95
+ # receiving bank. Businesses use this value to allowlist the companies permitted
96
+ # to debit their accounts. This value is configured by Increase and will be the
97
+ # same for all your transfers.
89
98
  sig { returns(String) }
90
99
  attr_accessor :company_id
91
100
 
@@ -173,10 +182,8 @@ module Increase
173
182
  sig { returns(T.nilable(String)) }
174
183
  attr_accessor :pending_transaction_id
175
184
 
176
- # Configuration for how the effective date of the transfer will be set. This
177
- # determines same-day vs future-dated settlement timing. If not set, defaults to a
178
- # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
179
- # must be set.
185
+ # Configuration for how the effective date of the transfer was set. This
186
+ # determines same-day vs future-dated settlement timing.
180
187
  sig { returns(Increase::ACHTransfer::PreferredEffectiveDate) }
181
188
  attr_reader :preferred_effective_date
182
189
 
@@ -223,7 +230,7 @@ module Increase
223
230
  attr_accessor :standard_entry_class_code
224
231
 
225
232
  # The descriptor that will show on the recipient's bank statement.
226
- sig { returns(String) }
233
+ sig { returns(T.nilable(String)) }
227
234
  attr_accessor :statement_descriptor
228
235
 
229
236
  # The lifecycle status of the transfer.
@@ -295,7 +302,7 @@ module Increase
295
302
  settlement: T.nilable(Increase::ACHTransfer::Settlement::OrHash),
296
303
  standard_entry_class_code:
297
304
  Increase::ACHTransfer::StandardEntryClassCode::OrSymbol,
298
- statement_descriptor: String,
305
+ statement_descriptor: T.nilable(String),
299
306
  status: Increase::ACHTransfer::Status::OrSymbol,
300
307
  submission: T.nilable(Increase::ACHTransfer::Submission::OrHash),
301
308
  transaction_id: T.nilable(String),
@@ -325,13 +332,22 @@ module Increase
325
332
  # If your account requires approvals for transfers and the transfer was not
326
333
  # approved, this will contain details of the cancellation.
327
334
  cancellation:,
328
- # The description of the date of the transfer.
335
+ # A description of the transfer date (typically `YYMMDD`), sent in the company
336
+ # batch header. This value is informational and does not affect funds movement,
337
+ # settlement timing, or returns.
329
338
  company_descriptive_date:,
330
- # The data you chose to associate with the transfer.
339
+ # Custom data sent in the company batch header, meant as metadata for the
340
+ # originator. This value is informational and does not affect funds movement,
341
+ # settlement timing, or returns.
331
342
  company_discretionary_data:,
332
- # The description of the transfer you set to be shown to the recipient.
343
+ # A short description sent in the company batch header, meant to provide the
344
+ # receiver with a reason for the transfer. Many receivers do not surface this data
345
+ # on the receiver's bank statement.
333
346
  company_entry_description:,
334
- # The company ID associated with the transfer.
347
+ # The Company ID sent in the batch header, which identifies the originator to the
348
+ # receiving bank. Businesses use this value to allowlist the companies permitted
349
+ # to debit their accounts. This value is configured by Increase and will be the
350
+ # same for all your transfers.
335
351
  company_id:,
336
352
  # The name by which the recipient knows you.
337
353
  company_name:,
@@ -372,10 +388,8 @@ module Increase
372
388
  # [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
373
389
  # by someone else in your organization.
374
390
  pending_transaction_id:,
375
- # Configuration for how the effective date of the transfer will be set. This
376
- # determines same-day vs future-dated settlement timing. If not set, defaults to a
377
- # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
378
- # must be set.
391
+ # Configuration for how the effective date of the transfer was set. This
392
+ # determines same-day vs future-dated settlement timing.
379
393
  preferred_effective_date:,
380
394
  # If your transfer is returned, this will contain details of the return.
381
395
  return_:,
@@ -446,7 +460,7 @@ module Increase
446
460
  settlement: T.nilable(Increase::ACHTransfer::Settlement),
447
461
  standard_entry_class_code:
448
462
  Increase::ACHTransfer::StandardEntryClassCode::TaggedSymbol,
449
- statement_descriptor: String,
463
+ statement_descriptor: T.nilable(String),
450
464
  status: Increase::ACHTransfer::Status::TaggedSymbol,
451
465
  submission: T.nilable(Increase::ACHTransfer::Submission),
452
466
  transaction_id: T.nilable(String),
@@ -1730,10 +1744,8 @@ module Increase
1730
1744
  end
1731
1745
  attr_accessor :settlement_schedule
1732
1746
 
1733
- # Configuration for how the effective date of the transfer will be set. This
1734
- # determines same-day vs future-dated settlement timing. If not set, defaults to a
1735
- # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
1736
- # must be set.
1747
+ # Configuration for how the effective date of the transfer was set. This
1748
+ # determines same-day vs future-dated settlement timing.
1737
1749
  sig do
1738
1750
  params(
1739
1751
  date: T.nilable(Date),
@@ -790,8 +790,13 @@ module Increase
790
790
  sig { returns(T.nilable(String)) }
791
791
  attr_accessor :note
792
792
 
793
+ # The payee of the check. This will be printed in the Pay to the Order Of portion
794
+ # of the check.
795
+ sig { returns(T::Array[Increase::CheckTransfer::PhysicalCheck::Payee]) }
796
+ attr_accessor :payee
797
+
793
798
  # The payer of the check. This will be printed on the top-left portion of the
794
- # check and defaults to the return address if unspecified.
799
+ # check.
795
800
  sig { returns(T::Array[Increase::CheckTransfer::PhysicalCheck::Payer]) }
796
801
  attr_accessor :payer
797
802
 
@@ -799,24 +804,14 @@ module Increase
799
804
  sig { returns(T.nilable(String)) }
800
805
  attr_accessor :physical_check_batch_id
801
806
 
802
- # The name that will be printed on the check.
803
- sig { returns(String) }
804
- attr_accessor :recipient_name
805
-
806
807
  # The return address to be printed on the check.
807
- sig do
808
- returns(
809
- T.nilable(Increase::CheckTransfer::PhysicalCheck::ReturnAddress)
810
- )
811
- end
808
+ sig { returns(Increase::CheckTransfer::PhysicalCheck::ReturnAddress) }
812
809
  attr_reader :return_address
813
810
 
814
811
  sig do
815
812
  params(
816
813
  return_address:
817
- T.nilable(
818
- Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
819
- )
814
+ Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
820
815
  ).void
821
816
  end
822
817
  attr_writer :return_address
@@ -863,14 +858,13 @@ module Increase
863
858
  Increase::CheckTransfer::PhysicalCheck::MailingAddress::OrHash,
864
859
  memo: T.nilable(String),
865
860
  note: T.nilable(String),
861
+ payee:
862
+ T::Array[Increase::CheckTransfer::PhysicalCheck::Payee::OrHash],
866
863
  payer:
867
864
  T::Array[Increase::CheckTransfer::PhysicalCheck::Payer::OrHash],
868
865
  physical_check_batch_id: T.nilable(String),
869
- recipient_name: String,
870
866
  return_address:
871
- T.nilable(
872
- Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
873
- ),
867
+ Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash,
874
868
  return_address_name: T.nilable(String),
875
869
  shipping_method:
876
870
  Increase::CheckTransfer::PhysicalCheck::ShippingMethod::OrSymbol,
@@ -893,13 +887,14 @@ module Increase
893
887
  memo:,
894
888
  # The descriptor that will be printed on the letter included with the check.
895
889
  note:,
890
+ # The payee of the check. This will be printed in the Pay to the Order Of portion
891
+ # of the check.
892
+ payee:,
896
893
  # The payer of the check. This will be printed on the top-left portion of the
897
- # check and defaults to the return address if unspecified.
894
+ # check.
898
895
  payer:,
899
896
  # The identifier of the Physical Check Batch that this check is a part of.
900
897
  physical_check_batch_id:,
901
- # The name that will be printed on the check.
902
- recipient_name:,
903
898
  # The return address to be printed on the check.
904
899
  return_address:,
905
900
  # A custom name printed above the Increase-managed return address.
@@ -923,13 +918,11 @@ module Increase
923
918
  Increase::CheckTransfer::PhysicalCheck::MailingAddress,
924
919
  memo: T.nilable(String),
925
920
  note: T.nilable(String),
921
+ payee: T::Array[Increase::CheckTransfer::PhysicalCheck::Payee],
926
922
  payer: T::Array[Increase::CheckTransfer::PhysicalCheck::Payer],
927
923
  physical_check_batch_id: T.nilable(String),
928
- recipient_name: String,
929
924
  return_address:
930
- T.nilable(
931
- Increase::CheckTransfer::PhysicalCheck::ReturnAddress
932
- ),
925
+ Increase::CheckTransfer::PhysicalCheck::ReturnAddress,
933
926
  return_address_name: T.nilable(String),
934
927
  shipping_method:
935
928
  Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol,
@@ -952,11 +945,11 @@ module Increase
952
945
  end
953
946
 
954
947
  # The city of the check's destination.
955
- sig { returns(T.nilable(String)) }
948
+ sig { returns(String) }
956
949
  attr_accessor :city
957
950
 
958
951
  # The street address of the check's destination.
959
- sig { returns(T.nilable(String)) }
952
+ sig { returns(String) }
960
953
  attr_accessor :line1
961
954
 
962
955
  # The second line of the address of the check's destination.
@@ -964,7 +957,7 @@ module Increase
964
957
  attr_accessor :line2
965
958
 
966
959
  # The name component of the check's mailing address.
967
- sig { returns(T.nilable(String)) }
960
+ sig { returns(String) }
968
961
  attr_accessor :name
969
962
 
970
963
  # The phone number to be used in case of delivery issues at the check's mailing
@@ -973,23 +966,23 @@ module Increase
973
966
  attr_accessor :phone
974
967
 
975
968
  # The postal code of the check's destination.
976
- sig { returns(T.nilable(String)) }
969
+ sig { returns(String) }
977
970
  attr_accessor :postal_code
978
971
 
979
972
  # The state of the check's destination.
980
- sig { returns(T.nilable(String)) }
973
+ sig { returns(String) }
981
974
  attr_accessor :state
982
975
 
983
976
  # Details for where Increase will mail the check.
984
977
  sig do
985
978
  params(
986
- city: T.nilable(String),
987
- line1: T.nilable(String),
979
+ city: String,
980
+ line1: String,
988
981
  line2: T.nilable(String),
989
- name: T.nilable(String),
982
+ name: String,
990
983
  phone: T.nilable(String),
991
- postal_code: T.nilable(String),
992
- state: T.nilable(String)
984
+ postal_code: String,
985
+ state: String
993
986
  ).returns(T.attached_class)
994
987
  end
995
988
  def self.new(
@@ -1014,13 +1007,13 @@ module Increase
1014
1007
  sig do
1015
1008
  override.returns(
1016
1009
  {
1017
- city: T.nilable(String),
1018
- line1: T.nilable(String),
1010
+ city: String,
1011
+ line1: String,
1019
1012
  line2: T.nilable(String),
1020
- name: T.nilable(String),
1013
+ name: String,
1021
1014
  phone: T.nilable(String),
1022
- postal_code: T.nilable(String),
1023
- state: T.nilable(String)
1015
+ postal_code: String,
1016
+ state: String
1024
1017
  }
1025
1018
  )
1026
1019
  end
@@ -1028,6 +1021,31 @@ module Increase
1028
1021
  end
1029
1022
  end
1030
1023
 
1024
+ class Payee < Increase::Internal::Type::BaseModel
1025
+ OrHash =
1026
+ T.type_alias do
1027
+ T.any(
1028
+ Increase::CheckTransfer::PhysicalCheck::Payee,
1029
+ Increase::Internal::AnyHash
1030
+ )
1031
+ end
1032
+
1033
+ # The contents of the line.
1034
+ sig { returns(String) }
1035
+ attr_accessor :contents
1036
+
1037
+ sig { params(contents: String).returns(T.attached_class) }
1038
+ def self.new(
1039
+ # The contents of the line.
1040
+ contents:
1041
+ )
1042
+ end
1043
+
1044
+ sig { override.returns({ contents: String }) }
1045
+ def to_hash
1046
+ end
1047
+ end
1048
+
1031
1049
  class Payer < Increase::Internal::Type::BaseModel
1032
1050
  OrHash =
1033
1051
  T.type_alias do
@@ -1063,11 +1081,11 @@ module Increase
1063
1081
  end
1064
1082
 
1065
1083
  # The city of the check's destination.
1066
- sig { returns(T.nilable(String)) }
1084
+ sig { returns(String) }
1067
1085
  attr_accessor :city
1068
1086
 
1069
1087
  # The street address of the check's destination.
1070
- sig { returns(T.nilable(String)) }
1088
+ sig { returns(String) }
1071
1089
  attr_accessor :line1
1072
1090
 
1073
1091
  # The second line of the address of the check's destination.
@@ -1075,7 +1093,7 @@ module Increase
1075
1093
  attr_accessor :line2
1076
1094
 
1077
1095
  # The name component of the check's return address.
1078
- sig { returns(T.nilable(String)) }
1096
+ sig { returns(String) }
1079
1097
  attr_accessor :name
1080
1098
 
1081
1099
  # The shipper's phone number to be used in case of delivery issues. Only used for
@@ -1084,23 +1102,23 @@ module Increase
1084
1102
  attr_accessor :phone
1085
1103
 
1086
1104
  # The postal code of the check's destination.
1087
- sig { returns(T.nilable(String)) }
1105
+ sig { returns(String) }
1088
1106
  attr_accessor :postal_code
1089
1107
 
1090
1108
  # The state of the check's destination.
1091
- sig { returns(T.nilable(String)) }
1109
+ sig { returns(String) }
1092
1110
  attr_accessor :state
1093
1111
 
1094
1112
  # The return address to be printed on the check.
1095
1113
  sig do
1096
1114
  params(
1097
- city: T.nilable(String),
1098
- line1: T.nilable(String),
1115
+ city: String,
1116
+ line1: String,
1099
1117
  line2: T.nilable(String),
1100
- name: T.nilable(String),
1118
+ name: String,
1101
1119
  phone: T.nilable(String),
1102
- postal_code: T.nilable(String),
1103
- state: T.nilable(String)
1120
+ postal_code: String,
1121
+ state: String
1104
1122
  ).returns(T.attached_class)
1105
1123
  end
1106
1124
  def self.new(
@@ -1125,13 +1143,13 @@ module Increase
1125
1143
  sig do
1126
1144
  override.returns(
1127
1145
  {
1128
- city: T.nilable(String),
1129
- line1: T.nilable(String),
1146
+ city: String,
1147
+ line1: String,
1130
1148
  line2: T.nilable(String),
1131
- name: T.nilable(String),
1149
+ name: String,
1132
1150
  phone: T.nilable(String),
1133
- postal_code: T.nilable(String),
1134
- state: T.nilable(String)
1151
+ postal_code: String,
1152
+ state: String
1135
1153
  }
1136
1154
  )
1137
1155
  end