increase 1.203.0 → 1.205.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 (53) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/increase/models/account_transfer.rb +25 -25
  5. data/lib/increase/models/ach_prenotification.rb +8 -8
  6. data/lib/increase/models/ach_transfer.rb +36 -36
  7. data/lib/increase/models/card_dispute.rb +79 -79
  8. data/lib/increase/models/card_payment.rb +82 -82
  9. data/lib/increase/models/card_push_transfer.rb +25 -25
  10. data/lib/increase/models/card_validation.rb +25 -25
  11. data/lib/increase/models/check_transfer.rb +25 -25
  12. data/lib/increase/models/declined_transaction.rb +53 -53
  13. data/lib/increase/models/fednow_transfer.rb +25 -25
  14. data/lib/increase/models/pending_transaction.rb +85 -85
  15. data/lib/increase/models/real_time_payments_transfer.rb +25 -25
  16. data/lib/increase/models/simulations/ach_transfer_return_params.rb +8 -8
  17. data/lib/increase/models/swift_transfer.rb +25 -25
  18. data/lib/increase/models/transaction.rb +181 -181
  19. data/lib/increase/models/wire_transfer.rb +28 -28
  20. data/lib/increase/version.rb +1 -1
  21. data/rbi/increase/models/account_transfer.rbi +40 -40
  22. data/rbi/increase/models/ach_prenotification.rbi +8 -8
  23. data/rbi/increase/models/ach_transfer.rbi +50 -50
  24. data/rbi/increase/models/card_dispute.rbi +141 -141
  25. data/rbi/increase/models/card_payment.rbi +144 -144
  26. data/rbi/increase/models/card_push_transfer.rbi +40 -40
  27. data/rbi/increase/models/card_validation.rbi +40 -40
  28. data/rbi/increase/models/check_transfer.rbi +40 -40
  29. data/rbi/increase/models/declined_transaction.rbi +99 -99
  30. data/rbi/increase/models/fednow_transfer.rbi +40 -40
  31. data/rbi/increase/models/pending_transaction.rbi +163 -163
  32. data/rbi/increase/models/real_time_payments_transfer.rbi +44 -44
  33. data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +8 -8
  34. data/rbi/increase/models/swift_transfer.rbi +40 -40
  35. data/rbi/increase/models/transaction.rbi +542 -542
  36. data/rbi/increase/models/wire_transfer.rbi +42 -42
  37. data/sig/increase/models/account_transfer.rbs +17 -17
  38. data/sig/increase/models/ach_prenotification.rbs +8 -8
  39. data/sig/increase/models/ach_transfer.rbs +27 -27
  40. data/sig/increase/models/card_dispute.rbs +56 -56
  41. data/sig/increase/models/card_payment.rbs +81 -81
  42. data/sig/increase/models/card_push_transfer.rbs +17 -17
  43. data/sig/increase/models/card_validation.rbs +17 -17
  44. data/sig/increase/models/check_transfer.rbs +17 -17
  45. data/sig/increase/models/declined_transaction.rbs +52 -52
  46. data/sig/increase/models/fednow_transfer.rbs +17 -17
  47. data/sig/increase/models/pending_transaction.rbs +92 -92
  48. data/sig/increase/models/real_time_payments_transfer.rbs +17 -17
  49. data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -8
  50. data/sig/increase/models/swift_transfer.rbs +17 -17
  51. data/sig/increase/models/transaction.rbs +210 -210
  52. data/sig/increase/models/wire_transfer.rbs +19 -19
  53. metadata +2 -2
@@ -167,12 +167,19 @@ module Increase
167
167
 
168
168
  # @see Increase::Models::PendingTransaction#source
169
169
  class Source < Increase::Internal::Type::BaseModel
170
+ # @!attribute category
171
+ # The type of the resource. We may add additional possible values for this enum
172
+ # over time; your application should be able to handle such additions gracefully.
173
+ #
174
+ # @return [Symbol, Increase::Models::PendingTransaction::Source::Category]
175
+ required :category, enum: -> { Increase::PendingTransaction::Source::Category }
176
+
170
177
  # @!attribute account_transfer_instruction
171
178
  # An Account Transfer Instruction object. This field will be present in the JSON
172
179
  # response if and only if `category` is equal to `account_transfer_instruction`.
173
180
  #
174
181
  # @return [Increase::Models::PendingTransaction::Source::AccountTransferInstruction, nil]
175
- required :account_transfer_instruction,
182
+ optional :account_transfer_instruction,
176
183
  -> { Increase::PendingTransaction::Source::AccountTransferInstruction },
177
184
  nil?: true
178
185
 
@@ -181,7 +188,7 @@ module Increase
181
188
  # response if and only if `category` is equal to `ach_transfer_instruction`.
182
189
  #
183
190
  # @return [Increase::Models::PendingTransaction::Source::ACHTransferInstruction, nil]
184
- required :ach_transfer_instruction,
191
+ optional :ach_transfer_instruction,
185
192
  -> { Increase::PendingTransaction::Source::ACHTransferInstruction },
186
193
  nil?: true
187
194
 
@@ -191,7 +198,7 @@ module Increase
191
198
  # `blockchain_offramp_transfer_instruction`.
192
199
  #
193
200
  # @return [Increase::Models::PendingTransaction::Source::BlockchainOfframpTransferInstruction, nil]
194
- required :blockchain_offramp_transfer_instruction,
201
+ optional :blockchain_offramp_transfer_instruction,
195
202
  -> { Increase::PendingTransaction::Source::BlockchainOfframpTransferInstruction },
196
203
  nil?: true
197
204
 
@@ -201,7 +208,7 @@ module Increase
201
208
  # `blockchain_onramp_transfer_instruction`.
202
209
  #
203
210
  # @return [Increase::Models::PendingTransaction::Source::BlockchainOnrampTransferInstruction, nil]
204
- required :blockchain_onramp_transfer_instruction,
211
+ optional :blockchain_onramp_transfer_instruction,
205
212
  -> { Increase::PendingTransaction::Source::BlockchainOnrampTransferInstruction },
206
213
  nil?: true
207
214
 
@@ -212,7 +219,7 @@ module Increase
212
219
  # transaction.
213
220
  #
214
221
  # @return [Increase::Models::PendingTransaction::Source::CardAuthorization, nil]
215
- required :card_authorization,
222
+ optional :card_authorization,
216
223
  -> {
217
224
  Increase::PendingTransaction::Source::CardAuthorization
218
225
  },
@@ -223,23 +230,16 @@ module Increase
223
230
  # response if and only if `category` is equal to `card_push_transfer_instruction`.
224
231
  #
225
232
  # @return [Increase::Models::PendingTransaction::Source::CardPushTransferInstruction, nil]
226
- required :card_push_transfer_instruction,
233
+ optional :card_push_transfer_instruction,
227
234
  -> { Increase::PendingTransaction::Source::CardPushTransferInstruction },
228
235
  nil?: true
229
236
 
230
- # @!attribute category
231
- # The type of the resource. We may add additional possible values for this enum
232
- # over time; your application should be able to handle such additions gracefully.
233
- #
234
- # @return [Symbol, Increase::Models::PendingTransaction::Source::Category]
235
- required :category, enum: -> { Increase::PendingTransaction::Source::Category }
236
-
237
237
  # @!attribute check_deposit_instruction
238
238
  # A Check Deposit Instruction object. This field will be present in the JSON
239
239
  # response if and only if `category` is equal to `check_deposit_instruction`.
240
240
  #
241
241
  # @return [Increase::Models::PendingTransaction::Source::CheckDepositInstruction, nil]
242
- required :check_deposit_instruction,
242
+ optional :check_deposit_instruction,
243
243
  -> { Increase::PendingTransaction::Source::CheckDepositInstruction },
244
244
  nil?: true
245
245
 
@@ -248,7 +248,7 @@ module Increase
248
248
  # response if and only if `category` is equal to `check_transfer_instruction`.
249
249
  #
250
250
  # @return [Increase::Models::PendingTransaction::Source::CheckTransferInstruction, nil]
251
- required :check_transfer_instruction,
251
+ optional :check_transfer_instruction,
252
252
  -> { Increase::PendingTransaction::Source::CheckTransferInstruction },
253
253
  nil?: true
254
254
 
@@ -257,7 +257,7 @@ module Increase
257
257
  # response if and only if `category` is equal to `fednow_transfer_instruction`.
258
258
  #
259
259
  # @return [Increase::Models::PendingTransaction::Source::FednowTransferInstruction, nil]
260
- required :fednow_transfer_instruction,
260
+ optional :fednow_transfer_instruction,
261
261
  -> { Increase::PendingTransaction::Source::FednowTransferInstruction },
262
262
  nil?: true
263
263
 
@@ -268,7 +268,7 @@ module Increase
268
268
  # be clawed back by the sending institution.
269
269
  #
270
270
  # @return [Increase::Models::PendingTransaction::Source::InboundFundsHold, nil]
271
- required :inbound_funds_hold,
271
+ optional :inbound_funds_hold,
272
272
  -> {
273
273
  Increase::PendingTransaction::Source::InboundFundsHold
274
274
  },
@@ -281,7 +281,7 @@ module Increase
281
281
  # and the User requests that it be reversed.
282
282
  #
283
283
  # @return [Increase::Models::PendingTransaction::Source::InboundWireTransferReversal, nil]
284
- required :inbound_wire_transfer_reversal,
284
+ optional :inbound_wire_transfer_reversal,
285
285
  -> { Increase::PendingTransaction::Source::InboundWireTransferReversal },
286
286
  nil?: true
287
287
 
@@ -290,7 +290,7 @@ module Increase
290
290
  # contain an empty object, otherwise it will contain null.
291
291
  #
292
292
  # @return [Increase::Models::PendingTransaction::Source::Other, nil]
293
- required :other, -> { Increase::PendingTransaction::Source::Other }, nil?: true
293
+ optional :other, -> { Increase::PendingTransaction::Source::Other }, nil?: true
294
294
 
295
295
  # @!attribute real_time_payments_transfer_instruction
296
296
  # A Real-Time Payments Transfer Instruction object. This field will be present in
@@ -298,7 +298,7 @@ module Increase
298
298
  # `real_time_payments_transfer_instruction`.
299
299
  #
300
300
  # @return [Increase::Models::PendingTransaction::Source::RealTimePaymentsTransferInstruction, nil]
301
- required :real_time_payments_transfer_instruction,
301
+ optional :real_time_payments_transfer_instruction,
302
302
  -> { Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction },
303
303
  nil?: true
304
304
 
@@ -307,7 +307,7 @@ module Increase
307
307
  # response if and only if `category` is equal to `swift_transfer_instruction`.
308
308
  #
309
309
  # @return [Increase::Models::PendingTransaction::Source::SwiftTransferInstruction, nil]
310
- required :swift_transfer_instruction,
310
+ optional :swift_transfer_instruction,
311
311
  -> { Increase::PendingTransaction::Source::SwiftTransferInstruction },
312
312
  nil?: true
313
313
 
@@ -317,7 +317,7 @@ module Increase
317
317
  # initiates a hold on funds in their account.
318
318
  #
319
319
  # @return [Hash{Symbol=>Object}, nil]
320
- required :user_initiated_hold,
320
+ optional :user_initiated_hold,
321
321
  Increase::Internal::Type::HashOf[Increase::Internal::Type::Unknown],
322
322
  nil?: true
323
323
 
@@ -326,11 +326,11 @@ module Increase
326
326
  # response if and only if `category` is equal to `wire_transfer_instruction`.
327
327
  #
328
328
  # @return [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil]
329
- required :wire_transfer_instruction,
329
+ optional :wire_transfer_instruction,
330
330
  -> { Increase::PendingTransaction::Source::WireTransferInstruction },
331
331
  nil?: true
332
332
 
333
- # @!method initialize(account_transfer_instruction:, ach_transfer_instruction:, blockchain_offramp_transfer_instruction:, blockchain_onramp_transfer_instruction:, card_authorization:, card_push_transfer_instruction:, category:, check_deposit_instruction:, check_transfer_instruction:, fednow_transfer_instruction:, inbound_funds_hold:, inbound_wire_transfer_reversal:, other:, real_time_payments_transfer_instruction:, swift_transfer_instruction:, user_initiated_hold:, wire_transfer_instruction:)
333
+ # @!method initialize(category:, account_transfer_instruction: nil, ach_transfer_instruction: nil, blockchain_offramp_transfer_instruction: nil, blockchain_onramp_transfer_instruction: nil, card_authorization: nil, card_push_transfer_instruction: nil, check_deposit_instruction: nil, check_transfer_instruction: nil, fednow_transfer_instruction: nil, inbound_funds_hold: nil, inbound_wire_transfer_reversal: nil, other: nil, real_time_payments_transfer_instruction: nil, swift_transfer_instruction: nil, user_initiated_hold: nil, wire_transfer_instruction: nil)
334
334
  # Some parameter documentations has been truncated, see
335
335
  # {Increase::Models::PendingTransaction::Source} for more details.
336
336
  #
@@ -338,6 +338,8 @@ module Increase
338
338
  # Pending Transaction. For example, for a card transaction this lists the
339
339
  # merchant's industry and location.
340
340
  #
341
+ # @param category [Symbol, Increase::Models::PendingTransaction::Source::Category] The type of the resource. We may add additional possible values for this enum ov
342
+ #
341
343
  # @param account_transfer_instruction [Increase::Models::PendingTransaction::Source::AccountTransferInstruction, nil] An Account Transfer Instruction object. This field will be present in the JSON r
342
344
  #
343
345
  # @param ach_transfer_instruction [Increase::Models::PendingTransaction::Source::ACHTransferInstruction, nil] An ACH Transfer Instruction object. This field will be present in the JSON respo
@@ -350,8 +352,6 @@ module Increase
350
352
  #
351
353
  # @param card_push_transfer_instruction [Increase::Models::PendingTransaction::Source::CardPushTransferInstruction, nil] A Card Push Transfer Instruction object. This field will be present in the JSON
352
354
  #
353
- # @param category [Symbol, Increase::Models::PendingTransaction::Source::Category] The type of the resource. We may add additional possible values for this enum ov
354
- #
355
355
  # @param check_deposit_instruction [Increase::Models::PendingTransaction::Source::CheckDepositInstruction, nil] A Check Deposit Instruction object. This field will be present in the JSON respo
356
356
  #
357
357
  # @param check_transfer_instruction [Increase::Models::PendingTransaction::Source::CheckTransferInstruction, nil] A Check Transfer Instruction object. This field will be present in the JSON resp
@@ -372,6 +372,65 @@ module Increase
372
372
  #
373
373
  # @param wire_transfer_instruction [Increase::Models::PendingTransaction::Source::WireTransferInstruction, nil] A Wire Transfer Instruction object. This field will be present in the JSON respo
374
374
 
375
+ # The type of the resource. We may add additional possible values for this enum
376
+ # over time; your application should be able to handle such additions gracefully.
377
+ #
378
+ # @see Increase::Models::PendingTransaction::Source#category
379
+ module Category
380
+ extend Increase::Internal::Type::Enum
381
+
382
+ # Account Transfer Instruction: details will be under the `account_transfer_instruction` object.
383
+ ACCOUNT_TRANSFER_INSTRUCTION = :account_transfer_instruction
384
+
385
+ # ACH Transfer Instruction: details will be under the `ach_transfer_instruction` object.
386
+ ACH_TRANSFER_INSTRUCTION = :ach_transfer_instruction
387
+
388
+ # Card Authorization: details will be under the `card_authorization` object.
389
+ CARD_AUTHORIZATION = :card_authorization
390
+
391
+ # Check Deposit Instruction: details will be under the `check_deposit_instruction` object.
392
+ CHECK_DEPOSIT_INSTRUCTION = :check_deposit_instruction
393
+
394
+ # Check Transfer Instruction: details will be under the `check_transfer_instruction` object.
395
+ CHECK_TRANSFER_INSTRUCTION = :check_transfer_instruction
396
+
397
+ # FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.
398
+ FEDNOW_TRANSFER_INSTRUCTION = :fednow_transfer_instruction
399
+
400
+ # Inbound Funds Hold: details will be under the `inbound_funds_hold` object.
401
+ INBOUND_FUNDS_HOLD = :inbound_funds_hold
402
+
403
+ # User Initiated Hold: details will be under the `user_initiated_hold` object.
404
+ USER_INITIATED_HOLD = :user_initiated_hold
405
+
406
+ # Real-Time Payments Transfer Instruction: details will be under the `real_time_payments_transfer_instruction` object.
407
+ REAL_TIME_PAYMENTS_TRANSFER_INSTRUCTION = :real_time_payments_transfer_instruction
408
+
409
+ # Wire Transfer Instruction: details will be under the `wire_transfer_instruction` object.
410
+ WIRE_TRANSFER_INSTRUCTION = :wire_transfer_instruction
411
+
412
+ # Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object.
413
+ INBOUND_WIRE_TRANSFER_REVERSAL = :inbound_wire_transfer_reversal
414
+
415
+ # Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object.
416
+ SWIFT_TRANSFER_INSTRUCTION = :swift_transfer_instruction
417
+
418
+ # Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.
419
+ CARD_PUSH_TRANSFER_INSTRUCTION = :card_push_transfer_instruction
420
+
421
+ # Blockchain On-Ramp Transfer Instruction: details will be under the `blockchain_onramp_transfer_instruction` object.
422
+ BLOCKCHAIN_ONRAMP_TRANSFER_INSTRUCTION = :blockchain_onramp_transfer_instruction
423
+
424
+ # Blockchain Off-Ramp Transfer Instruction: details will be under the `blockchain_offramp_transfer_instruction` object.
425
+ BLOCKCHAIN_OFFRAMP_TRANSFER_INSTRUCTION = :blockchain_offramp_transfer_instruction
426
+
427
+ # The Pending Transaction was made for an undocumented or deprecated reason.
428
+ OTHER = :other
429
+
430
+ # @!method self.values
431
+ # @return [Array<Symbol>]
432
+ end
433
+
375
434
  # @see Increase::Models::PendingTransaction::Source#account_transfer_instruction
376
435
  class AccountTransferInstruction < Increase::Internal::Type::BaseModel
377
436
  # @!attribute amount
@@ -1775,65 +1834,6 @@ module Increase
1775
1834
  # @param transfer_id [String] The identifier of the Card Push Transfer that led to this Pending Transaction.
1776
1835
  end
1777
1836
 
1778
- # The type of the resource. We may add additional possible values for this enum
1779
- # over time; your application should be able to handle such additions gracefully.
1780
- #
1781
- # @see Increase::Models::PendingTransaction::Source#category
1782
- module Category
1783
- extend Increase::Internal::Type::Enum
1784
-
1785
- # Account Transfer Instruction: details will be under the `account_transfer_instruction` object.
1786
- ACCOUNT_TRANSFER_INSTRUCTION = :account_transfer_instruction
1787
-
1788
- # ACH Transfer Instruction: details will be under the `ach_transfer_instruction` object.
1789
- ACH_TRANSFER_INSTRUCTION = :ach_transfer_instruction
1790
-
1791
- # Card Authorization: details will be under the `card_authorization` object.
1792
- CARD_AUTHORIZATION = :card_authorization
1793
-
1794
- # Check Deposit Instruction: details will be under the `check_deposit_instruction` object.
1795
- CHECK_DEPOSIT_INSTRUCTION = :check_deposit_instruction
1796
-
1797
- # Check Transfer Instruction: details will be under the `check_transfer_instruction` object.
1798
- CHECK_TRANSFER_INSTRUCTION = :check_transfer_instruction
1799
-
1800
- # FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.
1801
- FEDNOW_TRANSFER_INSTRUCTION = :fednow_transfer_instruction
1802
-
1803
- # Inbound Funds Hold: details will be under the `inbound_funds_hold` object.
1804
- INBOUND_FUNDS_HOLD = :inbound_funds_hold
1805
-
1806
- # User Initiated Hold: details will be under the `user_initiated_hold` object.
1807
- USER_INITIATED_HOLD = :user_initiated_hold
1808
-
1809
- # Real-Time Payments Transfer Instruction: details will be under the `real_time_payments_transfer_instruction` object.
1810
- REAL_TIME_PAYMENTS_TRANSFER_INSTRUCTION = :real_time_payments_transfer_instruction
1811
-
1812
- # Wire Transfer Instruction: details will be under the `wire_transfer_instruction` object.
1813
- WIRE_TRANSFER_INSTRUCTION = :wire_transfer_instruction
1814
-
1815
- # Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object.
1816
- INBOUND_WIRE_TRANSFER_REVERSAL = :inbound_wire_transfer_reversal
1817
-
1818
- # Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object.
1819
- SWIFT_TRANSFER_INSTRUCTION = :swift_transfer_instruction
1820
-
1821
- # Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.
1822
- CARD_PUSH_TRANSFER_INSTRUCTION = :card_push_transfer_instruction
1823
-
1824
- # Blockchain On-Ramp Transfer Instruction: details will be under the `blockchain_onramp_transfer_instruction` object.
1825
- BLOCKCHAIN_ONRAMP_TRANSFER_INSTRUCTION = :blockchain_onramp_transfer_instruction
1826
-
1827
- # Blockchain Off-Ramp Transfer Instruction: details will be under the `blockchain_offramp_transfer_instruction` object.
1828
- BLOCKCHAIN_OFFRAMP_TRANSFER_INSTRUCTION = :blockchain_offramp_transfer_instruction
1829
-
1830
- # The Pending Transaction was made for an undocumented or deprecated reason.
1831
- OTHER = :other
1832
-
1833
- # @!method self.values
1834
- # @return [Array<Symbol>]
1835
- end
1836
-
1837
1837
  # @see Increase::Models::PendingTransaction::Source#check_deposit_instruction
1838
1838
  class CheckDepositInstruction < Increase::Internal::Type::BaseModel
1839
1839
  # @!attribute amount
@@ -302,23 +302,23 @@ module Increase
302
302
 
303
303
  # @see Increase::Models::RealTimePaymentsTransfer#created_by
304
304
  class CreatedBy < Increase::Internal::Type::BaseModel
305
- # @!attribute api_key
306
- # If present, details about the API key that created the transfer.
307
- #
308
- # @return [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil]
309
- required :api_key, -> { Increase::RealTimePaymentsTransfer::CreatedBy::APIKey }, nil?: true
310
-
311
305
  # @!attribute category
312
306
  # The type of object that created this transfer.
313
307
  #
314
308
  # @return [Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category]
315
309
  required :category, enum: -> { Increase::RealTimePaymentsTransfer::CreatedBy::Category }
316
310
 
311
+ # @!attribute api_key
312
+ # If present, details about the API key that created the transfer.
313
+ #
314
+ # @return [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil]
315
+ optional :api_key, -> { Increase::RealTimePaymentsTransfer::CreatedBy::APIKey }, nil?: true
316
+
317
317
  # @!attribute oauth_application
318
318
  # If present, details about the OAuth Application that created the transfer.
319
319
  #
320
320
  # @return [Increase::Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, nil]
321
- required :oauth_application,
321
+ optional :oauth_application,
322
322
  -> { Increase::RealTimePaymentsTransfer::CreatedBy::OAuthApplication },
323
323
  nil?: true
324
324
 
@@ -326,33 +326,19 @@ module Increase
326
326
  # If present, details about the User that created the transfer.
327
327
  #
328
328
  # @return [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil]
329
- required :user, -> { Increase::RealTimePaymentsTransfer::CreatedBy::User }, nil?: true
329
+ optional :user, -> { Increase::RealTimePaymentsTransfer::CreatedBy::User }, nil?: true
330
330
 
331
- # @!method initialize(api_key:, category:, oauth_application:, user:)
331
+ # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
332
332
  # What object created the transfer, either via the API or the dashboard.
333
333
  #
334
- # @param api_key [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
335
- #
336
334
  # @param category [Symbol, Increase::Models::RealTimePaymentsTransfer::CreatedBy::Category] The type of object that created this transfer.
337
335
  #
336
+ # @param api_key [Increase::Models::RealTimePaymentsTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
337
+ #
338
338
  # @param oauth_application [Increase::Models::RealTimePaymentsTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
339
339
  #
340
340
  # @param user [Increase::Models::RealTimePaymentsTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
341
341
 
342
- # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#api_key
343
- class APIKey < Increase::Internal::Type::BaseModel
344
- # @!attribute description
345
- # The description set for the API key when it was created.
346
- #
347
- # @return [String, nil]
348
- required :description, String, nil?: true
349
-
350
- # @!method initialize(description:)
351
- # If present, details about the API key that created the transfer.
352
- #
353
- # @param description [String, nil] The description set for the API key when it was created.
354
- end
355
-
356
342
  # The type of object that created this transfer.
357
343
  #
358
344
  # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#category
@@ -372,6 +358,20 @@ module Increase
372
358
  # @return [Array<Symbol>]
373
359
  end
374
360
 
361
+ # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#api_key
362
+ class APIKey < Increase::Internal::Type::BaseModel
363
+ # @!attribute description
364
+ # The description set for the API key when it was created.
365
+ #
366
+ # @return [String, nil]
367
+ required :description, String, nil?: true
368
+
369
+ # @!method initialize(description:)
370
+ # If present, details about the API key that created the transfer.
371
+ #
372
+ # @param description [String, nil] The description set for the API key when it was created.
373
+ end
374
+
375
375
  # @see Increase::Models::RealTimePaymentsTransfer::CreatedBy#oauth_application
376
376
  class OAuthApplication < Increase::Internal::Type::BaseModel
377
377
  # @!attribute name
@@ -28,7 +28,7 @@ module Increase
28
28
  module Reason
29
29
  extend Increase::Internal::Type::Enum
30
30
 
31
- # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to NSF.
31
+ # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to "NSF."
32
32
  INSUFFICIENT_FUND = :insufficient_fund
33
33
 
34
34
  # Code R03. The account does not exist or the receiving bank was unable to locate it.
@@ -40,13 +40,13 @@ module Increase
40
40
  # Code R04. The account number is invalid at the receiving bank.
41
41
  INVALID_ACCOUNT_NUMBER_STRUCTURE = :invalid_account_number_structure
42
42
 
43
- # Code R16. The account at the receiving bank was frozen per the Office of Foreign Assets Control.
43
+ # Code R16. This return code has two separate meanings. (1) The receiving bank froze the account or (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank to return the entry.
44
44
  ACCOUNT_FROZEN_ENTRY_RETURNED_PER_OFAC_INSTRUCTION = :account_frozen_entry_returned_per_ofac_instruction
45
45
 
46
- # Code R23. The receiving bank account refused a credit transfer.
46
+ # Code R23. The receiving bank refused the credit transfer.
47
47
  CREDIT_ENTRY_REFUSED_BY_RECEIVER = :credit_entry_refused_by_receiver
48
48
 
49
- # Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code.
49
+ # Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code. Consumer accounts cannot be debited as `corporate_credit_or_debit` or `corporate_trade_exchange`.
50
50
  UNAUTHORIZED_DEBIT_TO_CONSUMER_ACCOUNT_USING_CORPORATE_SEC_CODE =
51
51
  :unauthorized_debit_to_consumer_account_using_corporate_sec_code
52
52
 
@@ -56,7 +56,7 @@ module Increase
56
56
  # Code R08. The receiving bank stopped payment on this transfer.
57
57
  PAYMENT_STOPPED = :payment_stopped
58
58
 
59
- # Code R20. The receiving bank account does not perform transfers.
59
+ # Code R20. The account is not eligible for ACH, such as a savings account with transaction limits.
60
60
  NON_TRANSACTION_ACCOUNT = :non_transaction_account
61
61
 
62
62
  # Code R09. The receiving bank account does not have enough available balance for the transfer.
@@ -72,7 +72,7 @@ module Increase
72
72
  # Code R19. The amount field is incorrect or too large.
73
73
  AMOUNT_FIELD_ERROR = :amount_field_error
74
74
 
75
- # Code R07. The customer at the receiving institution informed their bank that they have revoked authorization for a previously authorized transfer.
75
+ # Code R07. The customer revoked their authorization for a previously authorized transfer.
76
76
  AUTHORIZATION_REVOKED_BY_CUSTOMER = :authorization_revoked_by_customer
77
77
 
78
78
  # Code R13. The routing number is invalid.
@@ -81,7 +81,7 @@ module Increase
81
81
  # Code R17. The receiving bank is unable to process a field in the transfer.
82
82
  FILE_RECORD_EDIT_CRITERIA = :file_record_edit_criteria
83
83
 
84
- # Code R45. The individual name field was invalid.
84
+ # Code R45. A rare return reason. The individual name field was invalid.
85
85
  ENR_INVALID_INDIVIDUAL_NAME = :enr_invalid_individual_name
86
86
 
87
87
  # Code R06. The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.
@@ -214,7 +214,7 @@ module Increase
214
214
  # Code R35. A rare return reason. Return of a malformed debit entry.
215
215
  RETURN_OF_IMPROPER_DEBIT_ENTRY = :return_of_improper_debit_entry
216
216
 
217
- # Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry.
217
+ # Code R33. A rare return reason. Return of a destroyed check ("XCK") entry.
218
218
  RETURN_OF_XCK_ENTRY = :return_of_xck_entry
219
219
 
220
220
  # Code R37. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank.
@@ -198,55 +198,41 @@ module Increase
198
198
 
199
199
  # @see Increase::Models::SwiftTransfer#created_by
200
200
  class CreatedBy < Increase::Internal::Type::BaseModel
201
- # @!attribute api_key
202
- # If present, details about the API key that created the transfer.
203
- #
204
- # @return [Increase::Models::SwiftTransfer::CreatedBy::APIKey, nil]
205
- required :api_key, -> { Increase::SwiftTransfer::CreatedBy::APIKey }, nil?: true
206
-
207
201
  # @!attribute category
208
202
  # The type of object that created this transfer.
209
203
  #
210
204
  # @return [Symbol, Increase::Models::SwiftTransfer::CreatedBy::Category]
211
205
  required :category, enum: -> { Increase::SwiftTransfer::CreatedBy::Category }
212
206
 
207
+ # @!attribute api_key
208
+ # If present, details about the API key that created the transfer.
209
+ #
210
+ # @return [Increase::Models::SwiftTransfer::CreatedBy::APIKey, nil]
211
+ optional :api_key, -> { Increase::SwiftTransfer::CreatedBy::APIKey }, nil?: true
212
+
213
213
  # @!attribute oauth_application
214
214
  # If present, details about the OAuth Application that created the transfer.
215
215
  #
216
216
  # @return [Increase::Models::SwiftTransfer::CreatedBy::OAuthApplication, nil]
217
- required :oauth_application, -> { Increase::SwiftTransfer::CreatedBy::OAuthApplication }, nil?: true
217
+ optional :oauth_application, -> { Increase::SwiftTransfer::CreatedBy::OAuthApplication }, nil?: true
218
218
 
219
219
  # @!attribute user
220
220
  # If present, details about the User that created the transfer.
221
221
  #
222
222
  # @return [Increase::Models::SwiftTransfer::CreatedBy::User, nil]
223
- required :user, -> { Increase::SwiftTransfer::CreatedBy::User }, nil?: true
223
+ optional :user, -> { Increase::SwiftTransfer::CreatedBy::User }, nil?: true
224
224
 
225
- # @!method initialize(api_key:, category:, oauth_application:, user:)
225
+ # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
226
226
  # What object created the transfer, either via the API or the dashboard.
227
227
  #
228
- # @param api_key [Increase::Models::SwiftTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
229
- #
230
228
  # @param category [Symbol, Increase::Models::SwiftTransfer::CreatedBy::Category] The type of object that created this transfer.
231
229
  #
230
+ # @param api_key [Increase::Models::SwiftTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
231
+ #
232
232
  # @param oauth_application [Increase::Models::SwiftTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
233
233
  #
234
234
  # @param user [Increase::Models::SwiftTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
235
235
 
236
- # @see Increase::Models::SwiftTransfer::CreatedBy#api_key
237
- class APIKey < Increase::Internal::Type::BaseModel
238
- # @!attribute description
239
- # The description set for the API key when it was created.
240
- #
241
- # @return [String, nil]
242
- required :description, String, nil?: true
243
-
244
- # @!method initialize(description:)
245
- # If present, details about the API key that created the transfer.
246
- #
247
- # @param description [String, nil] The description set for the API key when it was created.
248
- end
249
-
250
236
  # The type of object that created this transfer.
251
237
  #
252
238
  # @see Increase::Models::SwiftTransfer::CreatedBy#category
@@ -266,6 +252,20 @@ module Increase
266
252
  # @return [Array<Symbol>]
267
253
  end
268
254
 
255
+ # @see Increase::Models::SwiftTransfer::CreatedBy#api_key
256
+ class APIKey < Increase::Internal::Type::BaseModel
257
+ # @!attribute description
258
+ # The description set for the API key when it was created.
259
+ #
260
+ # @return [String, nil]
261
+ required :description, String, nil?: true
262
+
263
+ # @!method initialize(description:)
264
+ # If present, details about the API key that created the transfer.
265
+ #
266
+ # @param description [String, nil] The description set for the API key when it was created.
267
+ end
268
+
269
269
  # @see Increase::Models::SwiftTransfer::CreatedBy#oauth_application
270
270
  class OAuthApplication < Increase::Internal::Type::BaseModel
271
271
  # @!attribute name