increase 1.333.1 → 1.334.1

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 (118) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +4 -5
  4. data/lib/increase/models/ach_prenotification.rb +5 -2
  5. data/lib/increase/models/ach_prenotification_create_params.rb +2 -2
  6. data/lib/increase/models/ach_transfer.rb +6 -3
  7. data/lib/increase/models/card.rb +9 -1
  8. data/lib/increase/models/card_dispute.rb +40 -1
  9. data/lib/increase/models/card_dispute_list_params.rb +3 -0
  10. data/lib/increase/models/card_payment.rb +65 -6
  11. data/lib/increase/models/card_push_transfer.rb +53 -1
  12. data/lib/increase/models/check_transfer.rb +4 -8
  13. data/lib/increase/models/declined_transaction.rb +1 -1
  14. data/lib/increase/models/digital_wallet_token.rb +59 -1
  15. data/lib/increase/models/entity.rb +1 -1
  16. data/lib/increase/models/event.rb +12 -0
  17. data/lib/increase/models/event_list_params.rb +12 -0
  18. data/lib/increase/models/event_subscription.rb +12 -0
  19. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  20. data/lib/increase/models/export.rb +17 -1
  21. data/lib/increase/models/export_create_params.rb +78 -1
  22. data/lib/increase/models/fednow_transfer.rb +47 -1
  23. data/lib/increase/models/inbound_wire_transfer.rb +9 -1
  24. data/lib/increase/models/pending_transaction.rb +54 -1
  25. data/lib/increase/models/physical_card.rb +1 -1
  26. data/lib/increase/models/physical_card_profile.rb +38 -1
  27. data/lib/increase/models/real_time_decision.rb +52 -1
  28. data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +3 -0
  29. data/lib/increase/models/simulations/card_authorization_create_params.rb +1 -1
  30. data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +1 -1
  31. data/lib/increase/models/simulations/check_deposit_submit_params.rb +21 -2
  32. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +6 -0
  33. data/lib/increase/models/simulations/entity_update_validation_params.rb +1 -1
  34. data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +10 -1
  35. data/lib/increase/models/simulations/physical_card_create_params.rb +1 -1
  36. data/lib/increase/models/transaction.rb +17 -5
  37. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  38. data/lib/increase/models/wire_drawdown_request.rb +20 -1
  39. data/lib/increase/resources/exports.rb +3 -1
  40. data/lib/increase/resources/simulations/check_deposits.rb +3 -0
  41. data/lib/increase/resources/simulations/inbound_wire_transfers.rb +3 -1
  42. data/lib/increase/version.rb +1 -1
  43. data/rbi/increase/models/ach_prenotification.rbi +9 -2
  44. data/rbi/increase/models/ach_prenotification_create_params.rbi +2 -2
  45. data/rbi/increase/models/ach_transfer.rbi +11 -4
  46. data/rbi/increase/models/card.rbi +8 -0
  47. data/rbi/increase/models/card_dispute.rbi +56 -0
  48. data/rbi/increase/models/card_dispute_list_params.rbi +7 -0
  49. data/rbi/increase/models/card_payment.rbi +135 -7
  50. data/rbi/increase/models/card_push_transfer.rbi +56 -0
  51. data/rbi/increase/models/check_transfer.rbi +4 -10
  52. data/rbi/increase/models/declined_transaction.rbi +1 -1
  53. data/rbi/increase/models/digital_wallet_token.rbi +131 -0
  54. data/rbi/increase/models/entity.rbi +1 -1
  55. data/rbi/increase/models/event.rbi +22 -0
  56. data/rbi/increase/models/event_list_params.rbi +28 -0
  57. data/rbi/increase/models/event_subscription.rbi +28 -0
  58. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  59. data/rbi/increase/models/export.rbi +25 -5
  60. data/rbi/increase/models/export_create_params.rbi +151 -0
  61. data/rbi/increase/models/fednow_transfer.rbi +77 -0
  62. data/rbi/increase/models/inbound_wire_transfer.rbi +8 -0
  63. data/rbi/increase/models/pending_transaction.rbi +122 -0
  64. data/rbi/increase/models/physical_card.rbi +1 -1
  65. data/rbi/increase/models/physical_card_profile.rbi +60 -0
  66. data/rbi/increase/models/real_time_decision.rbi +120 -0
  67. data/rbi/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi +7 -0
  68. data/rbi/increase/models/simulations/card_authorization_create_params.rbi +1 -1
  69. data/rbi/increase/models/simulations/card_balance_inquiry_create_params.rbi +1 -1
  70. data/rbi/increase/models/simulations/check_deposit_submit_params.rbi +21 -3
  71. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +14 -0
  72. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +1 -1
  73. data/rbi/increase/models/simulations/inbound_wire_transfer_create_params.rbi +13 -0
  74. data/rbi/increase/models/simulations/physical_card_create_params.rbi +1 -1
  75. data/rbi/increase/models/transaction.rbi +20 -6
  76. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  77. data/rbi/increase/models/wire_drawdown_request.rbi +22 -0
  78. data/rbi/increase/resources/exports.rbi +3 -0
  79. data/rbi/increase/resources/simulations/check_deposits.rbi +1 -0
  80. data/rbi/increase/resources/simulations/inbound_wire_transfers.rbi +4 -0
  81. data/sig/increase/models/ach_prenotification.rbs +7 -3
  82. data/sig/increase/models/ach_prenotification_create_params.rbs +2 -2
  83. data/sig/increase/models/ach_transfer.rbs +5 -1
  84. data/sig/increase/models/card.rbs +5 -0
  85. data/sig/increase/models/card_dispute.rbs +21 -0
  86. data/sig/increase/models/card_dispute_list_params.rbs +4 -0
  87. data/sig/increase/models/card_payment.rbs +37 -1
  88. data/sig/increase/models/card_push_transfer.rbs +30 -0
  89. data/sig/increase/models/check_transfer.rbs +5 -5
  90. data/sig/increase/models/declined_transaction.rbs +1 -1
  91. data/sig/increase/models/digital_wallet_token.rbs +61 -2
  92. data/sig/increase/models/entity.rbs +1 -1
  93. data/sig/increase/models/event.rbs +16 -0
  94. data/sig/increase/models/event_list_params.rbs +16 -0
  95. data/sig/increase/models/event_subscription.rbs +16 -0
  96. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  97. data/sig/increase/models/export.rbs +23 -3
  98. data/sig/increase/models/export_create_params.rbs +76 -0
  99. data/sig/increase/models/fednow_transfer.rbs +37 -0
  100. data/sig/increase/models/inbound_wire_transfer.rbs +5 -0
  101. data/sig/increase/models/pending_transaction.rbs +36 -0
  102. data/sig/increase/models/physical_card.rbs +1 -1
  103. data/sig/increase/models/physical_card_profile.rbs +17 -0
  104. data/sig/increase/models/real_time_decision.rbs +36 -0
  105. data/sig/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbs +5 -1
  106. data/sig/increase/models/simulations/card_authorization_create_params.rbs +1 -1
  107. data/sig/increase/models/simulations/card_balance_inquiry_create_params.rbs +1 -1
  108. data/sig/increase/models/simulations/check_deposit_submit_params.rbs +10 -3
  109. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +8 -0
  110. data/sig/increase/models/simulations/entity_update_validation_params.rbs +1 -1
  111. data/sig/increase/models/simulations/inbound_wire_transfer_create_params.rbs +7 -0
  112. data/sig/increase/models/simulations/physical_card_create_params.rbs +1 -1
  113. data/sig/increase/models/transaction.rbs +5 -0
  114. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  115. data/sig/increase/models/wire_drawdown_request.rbs +10 -0
  116. data/sig/increase/resources/exports.rbs +1 -0
  117. data/sig/increase/resources/simulations/inbound_wire_transfers.rbs +1 -0
  118. metadata +4 -4
@@ -289,6 +289,18 @@ module Increase
289
289
  # Occurs whenever an IntraFi Exclusion is updated.
290
290
  INTRAFI_EXCLUSION_UPDATED = :"intrafi_exclusion.updated"
291
291
 
292
+ # Occurs whenever a Loan Application is created.
293
+ LOAN_APPLICATION_CREATED = :"loan_application.created"
294
+
295
+ # Occurs whenever a Loan Application is updated.
296
+ LOAN_APPLICATION_UPDATED = :"loan_application.updated"
297
+
298
+ # Occurs whenever a Loan Offer is created.
299
+ LOAN_OFFER_CREATED = :"loan_offer.created"
300
+
301
+ # Occurs whenever a Loan Offer is updated.
302
+ LOAN_OFFER_UPDATED = :"loan_offer.updated"
303
+
292
304
  # Occurs whenever a Lockbox is created.
293
305
  LOCKBOX_CREATED = :"lockbox.created"
294
306
 
@@ -314,6 +314,18 @@ module Increase
314
314
  # Occurs whenever an IntraFi Exclusion is updated.
315
315
  INTRAFI_EXCLUSION_UPDATED = :"intrafi_exclusion.updated"
316
316
 
317
+ # Occurs whenever a Loan Application is created.
318
+ LOAN_APPLICATION_CREATED = :"loan_application.created"
319
+
320
+ # Occurs whenever a Loan Application is updated.
321
+ LOAN_APPLICATION_UPDATED = :"loan_application.updated"
322
+
323
+ # Occurs whenever a Loan Offer is created.
324
+ LOAN_OFFER_CREATED = :"loan_offer.created"
325
+
326
+ # Occurs whenever a Loan Offer is updated.
327
+ LOAN_OFFER_UPDATED = :"loan_offer.updated"
328
+
317
329
  # Occurs whenever a Lockbox is created.
318
330
  LOCKBOX_CREATED = :"lockbox.created"
319
331
 
@@ -285,6 +285,18 @@ module Increase
285
285
  # Occurs whenever an IntraFi Exclusion is updated.
286
286
  INTRAFI_EXCLUSION_UPDATED = :"intrafi_exclusion.updated"
287
287
 
288
+ # Occurs whenever a Loan Application is created.
289
+ LOAN_APPLICATION_CREATED = :"loan_application.created"
290
+
291
+ # Occurs whenever a Loan Application is updated.
292
+ LOAN_APPLICATION_UPDATED = :"loan_application.updated"
293
+
294
+ # Occurs whenever a Loan Offer is created.
295
+ LOAN_OFFER_CREATED = :"loan_offer.created"
296
+
297
+ # Occurs whenever a Loan Offer is updated.
298
+ LOAN_OFFER_UPDATED = :"loan_offer.updated"
299
+
288
300
  # Occurs whenever a Lockbox is created.
289
301
  LOCKBOX_CREATED = :"lockbox.created"
290
302
 
@@ -520,13 +520,29 @@ module Increase
520
520
  # @return [Time, nil]
521
521
  required :before, Time, nil?: true
522
522
 
523
- # @!method initialize(after:, before:)
523
+ # @!attribute on_or_after
524
+ # Filter fees created on or after this time.
525
+ #
526
+ # @return [Time, nil]
527
+ required :on_or_after, Time, nil?: true
528
+
529
+ # @!attribute on_or_before
530
+ # Filter fees created on or before this time.
531
+ #
532
+ # @return [Time, nil]
533
+ required :on_or_before, Time, nil?: true
534
+
535
+ # @!method initialize(after:, before:, on_or_after:, on_or_before:)
524
536
  # Filter fees by their created date. The time range must not include any fees that
525
537
  # are part of an open fee statement.
526
538
  #
527
539
  # @param after [Time, nil] Filter fees created after this time.
528
540
  #
529
541
  # @param before [Time, nil] Filter fees created before this time.
542
+ #
543
+ # @param on_or_after [Time, nil] Filter fees created on or after this time.
544
+ #
545
+ # @param on_or_before [Time, nil] Filter fees created on or before this time.
530
546
  end
531
547
  end
532
548
 
@@ -55,6 +55,12 @@ module Increase
55
55
  # @return [Increase::Models::ExportCreateParams::EntityCsv, nil]
56
56
  optional :entity_csv, -> { Increase::ExportCreateParams::EntityCsv }
57
57
 
58
+ # @!attribute fee_csv
59
+ # Options for the created export. Required if `category` is equal to `fee_csv`.
60
+ #
61
+ # @return [Increase::Models::ExportCreateParams::FeeCsv, nil]
62
+ optional :fee_csv, -> { Increase::ExportCreateParams::FeeCsv }
63
+
58
64
  # @!attribute funding_instructions
59
65
  # Options for the created export. Required if `category` is equal to
60
66
  # `funding_instructions`.
@@ -82,7 +88,7 @@ module Increase
82
88
  # @return [Increase::Models::ExportCreateParams::VoidedCheck, nil]
83
89
  optional :voided_check, -> { Increase::ExportCreateParams::VoidedCheck }
84
90
 
85
- # @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
91
+ # @!method initialize(category:, account_statement_bai2: nil, account_statement_ofx: nil, account_verification_letter: nil, bookkeeping_account_balance_csv: nil, daily_account_balance_csv: nil, entity_csv: nil, fee_csv: nil, funding_instructions: nil, transaction_csv: nil, vendor_csv: nil, voided_check: nil, request_options: {})
86
92
  # Some parameter documentations has been truncated, see
87
93
  # {Increase::Models::ExportCreateParams} for more details.
88
94
  #
@@ -101,6 +107,8 @@ module Increase
101
107
  #
102
108
  # @param entity_csv [Increase::Models::ExportCreateParams::EntityCsv] Options for the created export. Required if `category` is equal to `entity_csv`.
103
109
  #
110
+ # @param fee_csv [Increase::Models::ExportCreateParams::FeeCsv] Options for the created export. Required if `category` is equal to `fee_csv`.
111
+ #
104
112
  # @param funding_instructions [Increase::Models::ExportCreateParams::FundingInstructions] Options for the created export. Required if `category` is equal to `funding_inst
105
113
  #
106
114
  # @param transaction_csv [Increase::Models::ExportCreateParams::TransactionCsv] Options for the created export. Required if `category` is equal to
@@ -143,6 +151,9 @@ module Increase
143
151
  # A PDF of funding instructions.
144
152
  FUNDING_INSTRUCTIONS = :funding_instructions
145
153
 
154
+ # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
155
+ FEE_CSV = :fee_csv
156
+
146
157
  # A PDF of a voided check.
147
158
  VOIDED_CHECK = :voided_check
148
159
 
@@ -327,6 +338,72 @@ module Increase
327
338
  # Options for the created export. Required if `category` is equal to `entity_csv`.
328
339
  end
329
340
 
341
+ class FeeCsv < Increase::Internal::Type::BaseModel
342
+ # @!attribute created_at
343
+ # Filter results by time range on the `created_at` attribute.
344
+ #
345
+ # @return [Increase::Models::ExportCreateParams::FeeCsv::CreatedAt, nil]
346
+ optional :created_at, -> { Increase::ExportCreateParams::FeeCsv::CreatedAt }
347
+
348
+ # @!attribute program_id
349
+ # Filter exported Fees to the specified Program.
350
+ #
351
+ # @return [String, nil]
352
+ optional :program_id, String
353
+
354
+ # @!method initialize(created_at: nil, program_id: nil)
355
+ # Options for the created export. Required if `category` is equal to `fee_csv`.
356
+ #
357
+ # @param created_at [Increase::Models::ExportCreateParams::FeeCsv::CreatedAt] Filter results by time range on the `created_at` attribute.
358
+ #
359
+ # @param program_id [String] Filter exported Fees to the specified Program.
360
+
361
+ # @see Increase::Models::ExportCreateParams::FeeCsv#created_at
362
+ class CreatedAt < Increase::Internal::Type::BaseModel
363
+ # @!attribute after
364
+ # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
365
+ # timestamp.
366
+ #
367
+ # @return [Time, nil]
368
+ optional :after, Time
369
+
370
+ # @!attribute before
371
+ # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
372
+ # timestamp.
373
+ #
374
+ # @return [Time, nil]
375
+ optional :before, Time
376
+
377
+ # @!attribute on_or_after
378
+ # Return results on or after this
379
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
380
+ #
381
+ # @return [Time, nil]
382
+ optional :on_or_after, Time
383
+
384
+ # @!attribute on_or_before
385
+ # Return results on or before this
386
+ # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
387
+ #
388
+ # @return [Time, nil]
389
+ optional :on_or_before, Time
390
+
391
+ # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
392
+ # Some parameter documentations has been truncated, see
393
+ # {Increase::Models::ExportCreateParams::FeeCsv::CreatedAt} for more details.
394
+ #
395
+ # Filter results by time range on the `created_at` attribute.
396
+ #
397
+ # @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
398
+ #
399
+ # @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
400
+ #
401
+ # @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
402
+ #
403
+ # @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
404
+ end
405
+ end
406
+
330
407
  class FundingInstructions < Increase::Internal::Type::BaseModel
331
408
  # @!attribute account_number_id
332
409
  # The Account Number to create funding instructions for.
@@ -68,6 +68,12 @@ module Increase
68
68
  # @return [Symbol, Increase::Models::FednowTransfer::Currency]
69
69
  required :currency, enum: -> { Increase::FednowTransfer::Currency }
70
70
 
71
+ # @!attribute debtor_address
72
+ # The debtor's address.
73
+ #
74
+ # @return [Increase::Models::FednowTransfer::DebtorAddress, nil]
75
+ required :debtor_address, -> { Increase::FednowTransfer::DebtorAddress }, nil?: true
76
+
71
77
  # @!attribute debtor_name
72
78
  # The name of the transfer's sender. If not provided, defaults to the name of the
73
79
  # account's entity.
@@ -155,7 +161,7 @@ module Increase
155
161
  # @return [String]
156
162
  required :unstructured_remittance_information, String
157
163
 
158
- # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
164
+ # @!method initialize(id:, account_id:, account_number:, acknowledgement:, amount:, created_at:, created_by:, creditor_address:, creditor_name:, currency:, debtor_address:, debtor_name:, external_account_id:, idempotency_key:, pending_transaction_id:, rejection:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
159
165
  # Some parameter documentations has been truncated, see
160
166
  # {Increase::Models::FednowTransfer} for more details.
161
167
  #
@@ -182,6 +188,8 @@ module Increase
182
188
  #
183
189
  # @param currency [Symbol, Increase::Models::FednowTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's c
184
190
  #
191
+ # @param debtor_address [Increase::Models::FednowTransfer::DebtorAddress, nil] The debtor's address.
192
+ #
185
193
  # @param debtor_name [String] The name of the transfer's sender. If not provided, defaults to the name of the
186
194
  #
187
195
  # @param external_account_id [String, nil] The identifier of the External Account the transfer was made to, if any.
@@ -374,6 +382,44 @@ module Increase
374
382
  # @return [Array<Symbol>]
375
383
  end
376
384
 
385
+ # @see Increase::Models::FednowTransfer#debtor_address
386
+ class DebtorAddress < Increase::Internal::Type::BaseModel
387
+ # @!attribute city
388
+ # The city, district, town, or village of the address.
389
+ #
390
+ # @return [String, nil]
391
+ required :city, String, nil?: true
392
+
393
+ # @!attribute line1
394
+ # The first line of the address.
395
+ #
396
+ # @return [String, nil]
397
+ required :line1, String, nil?: true
398
+
399
+ # @!attribute postal_code
400
+ # The ZIP code of the address.
401
+ #
402
+ # @return [String, nil]
403
+ required :postal_code, String, nil?: true
404
+
405
+ # @!attribute state
406
+ # The address state.
407
+ #
408
+ # @return [String, nil]
409
+ required :state, String, nil?: true
410
+
411
+ # @!method initialize(city:, line1:, postal_code:, state:)
412
+ # The debtor's address.
413
+ #
414
+ # @param city [String, nil] The city, district, town, or village of the address.
415
+ #
416
+ # @param line1 [String, nil] The first line of the address.
417
+ #
418
+ # @param postal_code [String, nil] The ZIP code of the address.
419
+ #
420
+ # @param state [String, nil] The address state.
421
+ end
422
+
377
423
  # @see Increase::Models::FednowTransfer#rejection
378
424
  class Rejection < Increase::Internal::Type::BaseModel
379
425
  # @!attribute reject_reason_additional_information
@@ -122,6 +122,12 @@ module Increase
122
122
  # @return [String, nil]
123
123
  required :instruction_identification, String, nil?: true
124
124
 
125
+ # @!attribute purpose
126
+ # The reason for the wire transfer, as set by the sender.
127
+ #
128
+ # @return [String, nil]
129
+ required :purpose, String, nil?: true
130
+
125
131
  # @!attribute reversal
126
132
  # If the transfer is reversed, this will contain details of the reversal.
127
133
  #
@@ -161,7 +167,7 @@ module Increase
161
167
  # @return [String, nil]
162
168
  required :wire_drawdown_request_id, String, nil?: true
163
169
 
164
- # @!method initialize(id:, acceptance:, account_id:, account_number_id:, amount:, created_at:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, reversal:, status:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:, wire_drawdown_request_id:)
170
+ # @!method initialize(id:, acceptance:, account_id:, account_number_id:, amount:, created_at:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, reversal:, status:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:, wire_drawdown_request_id:)
165
171
  # Some parameter documentations has been truncated, see
166
172
  # {Increase::Models::InboundWireTransfer} for more details.
167
173
  #
@@ -206,6 +212,8 @@ module Increase
206
212
  #
207
213
  # @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
208
214
  #
215
+ # @param purpose [String, nil] The reason for the wire transfer, as set by the sender.
216
+ #
209
217
  # @param reversal [Increase::Models::InboundWireTransfer::Reversal, nil] If the transfer is reversed, this will contain details of the reversal.
210
218
  #
211
219
  # @param status [Symbol, Increase::Models::InboundWireTransfer::Status] The status of the transfer.
@@ -746,6 +746,15 @@ module Increase
746
746
  # @return [Time]
747
747
  required :expires_at, Time
748
748
 
749
+ # @!attribute healthcare
750
+ # The healthcare-related fields for this authorization. Only present for specific
751
+ # programs.
752
+ #
753
+ # @return [Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare, nil]
754
+ required :healthcare,
755
+ -> { Increase::PendingTransaction::Source::CardAuthorization::Healthcare },
756
+ nil?: true
757
+
749
758
  # @!attribute merchant_acceptor_id
750
759
  # The merchant identifier (commonly abbreviated as MID) of the merchant the card
751
760
  # is transacting with.
@@ -880,7 +889,7 @@ module Increase
880
889
  # @return [Increase::Models::PendingTransaction::Source::CardAuthorization::Verification]
881
890
  required :verification, -> { Increase::PendingTransaction::Source::CardAuthorization::Verification }
882
891
 
883
- # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
892
+ # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
884
893
  # Some parameter documentations has been truncated, see
885
894
  # {Increase::Models::PendingTransaction::Source::CardAuthorization} for more
886
895
  # details.
@@ -908,6 +917,8 @@ module Increase
908
917
  #
909
918
  # @param expires_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization w
910
919
  #
920
+ # @param healthcare [Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare, nil] The healthcare-related fields for this authorization. Only present for specific
921
+ #
911
922
  # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
912
923
  #
913
924
  # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
@@ -1421,6 +1432,48 @@ module Increase
1421
1432
  # @return [Array<Symbol>]
1422
1433
  end
1423
1434
 
1435
+ # @see Increase::Models::PendingTransaction::Source::CardAuthorization#healthcare
1436
+ class Healthcare < Increase::Internal::Type::BaseModel
1437
+ # @!attribute merchant_ninety_percent_eligibility
1438
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1439
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1440
+ # products. The eligibility is determined based on the list of merchants
1441
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
1442
+ #
1443
+ # @return [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility]
1444
+ required :merchant_ninety_percent_eligibility,
1445
+ enum: -> { Increase::PendingTransaction::Source::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility }
1446
+
1447
+ # @!method initialize(merchant_ninety_percent_eligibility:)
1448
+ # Some parameter documentations has been truncated, see
1449
+ # {Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare}
1450
+ # for more details.
1451
+ #
1452
+ # The healthcare-related fields for this authorization. Only present for specific
1453
+ # programs.
1454
+ #
1455
+ # @param merchant_ninety_percent_eligibility [Symbol, Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility] The merchant's eligibility under the Internal Revenue Service's 90% Rule for Fle
1456
+
1457
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1458
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1459
+ # products. The eligibility is determined based on the list of merchants
1460
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
1461
+ #
1462
+ # @see Increase::Models::PendingTransaction::Source::CardAuthorization::Healthcare#merchant_ninety_percent_eligibility
1463
+ module MerchantNinetyPercentEligibility
1464
+ extend Increase::Internal::Type::Enum
1465
+
1466
+ # The merchant is eligible for treatment under the 90% rule.
1467
+ ELIGIBLE = :eligible
1468
+
1469
+ # The merchant is not eligible for treatment under the 90% rule.
1470
+ NOT_ELIGIBLE = :not_eligible
1471
+
1472
+ # @!method self.values
1473
+ # @return [Array<Symbol>]
1474
+ end
1475
+ end
1476
+
1424
1477
  # @see Increase::Models::PendingTransaction::Source::CardAuthorization#network_details
1425
1478
  class NetworkDetails < Increase::Internal::Type::BaseModel
1426
1479
  # @!attribute category
@@ -428,7 +428,7 @@ module Increase
428
428
  # The physical card has been processed for delivery.
429
429
  PROCESSED_FOR_DELIVERY = :processed_for_delivery
430
430
 
431
- # The physical card has been delivered.
431
+ # The physical card has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single physical card may have more than one delivered event.
432
432
  DELIVERED = :delivered
433
433
 
434
434
  # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender.
@@ -56,6 +56,13 @@ module Increase
56
56
  # @return [String, nil]
57
57
  required :front_image_file_id, String, nil?: true
58
58
 
59
+ # @!attribute front_text
60
+ # Text printed on the front of the card. Reach out to
61
+ # [support@increase.com](mailto:support@increase.com) for more information.
62
+ #
63
+ # @return [Increase::Models::PhysicalCardProfile::FrontText, nil]
64
+ required :front_text, -> { Increase::PhysicalCardProfile::FrontText }, nil?: true
65
+
59
66
  # @!attribute idempotency_key
60
67
  # The idempotency key you chose for this object. This value is unique across
61
68
  # Increase and is used to ensure that a request is only processed once. Learn more
@@ -90,7 +97,7 @@ module Increase
90
97
  # @return [Symbol, Increase::Models::PhysicalCardProfile::Type]
91
98
  required :type, enum: -> { Increase::PhysicalCardProfile::Type }
92
99
 
93
- # @!method initialize(id:, back_image_file_id:, carrier_image_file_id:, contact_phone:, created_at:, creator:, description:, front_image_file_id:, idempotency_key:, is_default:, program_id:, status:, type:)
100
+ # @!method initialize(id:, back_image_file_id:, carrier_image_file_id:, contact_phone:, created_at:, creator:, description:, front_image_file_id:, front_text:, idempotency_key:, is_default:, program_id:, status:, type:)
94
101
  # Some parameter documentations has been truncated, see
95
102
  # {Increase::Models::PhysicalCardProfile} for more details.
96
103
  #
@@ -114,6 +121,8 @@ module Increase
114
121
  #
115
122
  # @param front_image_file_id [String, nil] The identifier of the File containing the physical card's front image. This will
116
123
  #
124
+ # @param front_text [Increase::Models::PhysicalCardProfile::FrontText, nil] Text printed on the front of the card. Reach out to [support@increase.com](mailt
125
+ #
117
126
  # @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
118
127
  #
119
128
  # @param is_default [Boolean] Whether this Physical Card Profile is the default for all cards in its Increase
@@ -140,6 +149,34 @@ module Increase
140
149
  # @return [Array<Symbol>]
141
150
  end
142
151
 
152
+ # @see Increase::Models::PhysicalCardProfile#front_text
153
+ class FrontText < Increase::Internal::Type::BaseModel
154
+ # @!attribute line1
155
+ # The first line of text on the front of the card.
156
+ #
157
+ # @return [String]
158
+ required :line1, String
159
+
160
+ # @!attribute line2
161
+ # The second line of text on the front of the card. Providing a second line moves
162
+ # the first line slightly higher and prints the second line in the spot where the
163
+ # first line would have otherwise been printed.
164
+ #
165
+ # @return [String, nil]
166
+ required :line2, String, nil?: true
167
+
168
+ # @!method initialize(line1:, line2:)
169
+ # Some parameter documentations has been truncated, see
170
+ # {Increase::Models::PhysicalCardProfile::FrontText} for more details.
171
+ #
172
+ # Text printed on the front of the card. Reach out to
173
+ # [support@increase.com](mailto:support@increase.com) for more information.
174
+ #
175
+ # @param line1 [String] The first line of text on the front of the card.
176
+ #
177
+ # @param line2 [String, nil] The second line of text on the front of the card. Providing a second line moves
178
+ end
179
+
143
180
  # The status of the Physical Card Profile.
144
181
  #
145
182
  # @see Increase::Models::PhysicalCardProfile#status
@@ -967,6 +967,13 @@ module Increase
967
967
  # @return [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction]
968
968
  required :direction, enum: -> { Increase::RealTimeDecision::CardAuthorization::Direction }
969
969
 
970
+ # @!attribute healthcare
971
+ # The healthcare-related fields for this authorization. Only present for specific
972
+ # programs.
973
+ #
974
+ # @return [Increase::Models::RealTimeDecision::CardAuthorization::Healthcare, nil]
975
+ required :healthcare, -> { Increase::RealTimeDecision::CardAuthorization::Healthcare }, nil?: true
976
+
970
977
  # @!attribute merchant_acceptor_id
971
978
  # The merchant identifier (commonly abbreviated as MID) of the merchant the card
972
979
  # is transacting with.
@@ -1109,7 +1116,7 @@ module Increase
1109
1116
  # @return [Increase::Models::RealTimeDecision::CardAuthorization::Verification]
1110
1117
  required :verification, -> { Increase::RealTimeDecision::CardAuthorization::Verification }
1111
1118
 
1112
- # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, decline:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, partial_approval_capability:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:)
1119
+ # @!method initialize(account_id:, additional_amounts:, approval:, card_id:, decision:, decline:, digital_wallet_token_id:, direction:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, partial_approval_capability:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, request_details:, settlement_amount:, settlement_currency:, terminal_id:, upcoming_card_payment_id:, verification:)
1113
1120
  # Some parameter documentations has been truncated, see
1114
1121
  # {Increase::Models::RealTimeDecision::CardAuthorization} for more details.
1115
1122
  #
@@ -1131,6 +1138,8 @@ module Increase
1131
1138
  #
1132
1139
  # @param direction [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Direction] The direction describes the direction the funds will move, either from the cardh
1133
1140
  #
1141
+ # @param healthcare [Increase::Models::RealTimeDecision::CardAuthorization::Healthcare, nil] The healthcare-related fields for this authorization. Only present for specific
1142
+ #
1134
1143
  # @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
1135
1144
  #
1136
1145
  # @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
@@ -1671,6 +1680,48 @@ module Increase
1671
1680
  # @return [Array<Symbol>]
1672
1681
  end
1673
1682
 
1683
+ # @see Increase::Models::RealTimeDecision::CardAuthorization#healthcare
1684
+ class Healthcare < Increase::Internal::Type::BaseModel
1685
+ # @!attribute merchant_ninety_percent_eligibility
1686
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1687
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1688
+ # products. The eligibility is determined based on the list of merchants
1689
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
1690
+ #
1691
+ # @return [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility]
1692
+ required :merchant_ninety_percent_eligibility,
1693
+ enum: -> { Increase::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility }
1694
+
1695
+ # @!method initialize(merchant_ninety_percent_eligibility:)
1696
+ # Some parameter documentations has been truncated, see
1697
+ # {Increase::Models::RealTimeDecision::CardAuthorization::Healthcare} for more
1698
+ # details.
1699
+ #
1700
+ # The healthcare-related fields for this authorization. Only present for specific
1701
+ # programs.
1702
+ #
1703
+ # @param merchant_ninety_percent_eligibility [Symbol, Increase::Models::RealTimeDecision::CardAuthorization::Healthcare::MerchantNinetyPercentEligibility] The merchant's eligibility under the Internal Revenue Service's 90% Rule for Fle
1704
+
1705
+ # The merchant's eligibility under the Internal Revenue Service's 90% Rule for
1706
+ # Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible
1707
+ # products. The eligibility is determined based on the list of merchants
1708
+ # maintained by the Special Interest Group for IIAS Standards (SIGIS).
1709
+ #
1710
+ # @see Increase::Models::RealTimeDecision::CardAuthorization::Healthcare#merchant_ninety_percent_eligibility
1711
+ module MerchantNinetyPercentEligibility
1712
+ extend Increase::Internal::Type::Enum
1713
+
1714
+ # The merchant is eligible for treatment under the 90% rule.
1715
+ ELIGIBLE = :eligible
1716
+
1717
+ # The merchant is not eligible for treatment under the 90% rule.
1718
+ NOT_ELIGIBLE = :not_eligible
1719
+
1720
+ # @!method self.values
1721
+ # @return [Array<Symbol>]
1722
+ end
1723
+ end
1724
+
1674
1725
  # @see Increase::Models::RealTimeDecision::CardAuthorization#network_details
1675
1726
  class NetworkDetails < Increase::Internal::Type::BaseModel
1676
1727
  # @!attribute category
@@ -67,6 +67,9 @@ module Increase
67
67
  # A savings account.
68
68
  SAVINGS = :savings
69
69
 
70
+ # A loan account used in a lender-borrower relationship. Uncommon.
71
+ LOAN = :loan
72
+
70
73
  # A bank's general ledger. Uncommon.
71
74
  GENERAL_LEDGER = :general_ledger
72
75
 
@@ -199,7 +199,7 @@ module Increase
199
199
  # The attempted card transaction is not allowed per Increase's terms.
200
200
  TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
201
201
 
202
- # The transaction was blocked by a Limit.
202
+ # The transaction was blocked by a limit or an authorization control.
203
203
  BREACHES_LIMIT = :breaches_limit
204
204
 
205
205
  # Your application declined the transaction via webhook.
@@ -182,7 +182,7 @@ module Increase
182
182
  # The attempted card transaction is not allowed per Increase's terms.
183
183
  TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
184
184
 
185
- # The transaction was blocked by a Limit.
185
+ # The transaction was blocked by a limit or an authorization control.
186
186
  BREACHES_LIMIT = :breaches_limit
187
187
 
188
188
  # Your application declined the transaction via webhook.
@@ -16,11 +16,15 @@ module Increase
16
16
 
17
17
  # @!attribute scan
18
18
  # If set, the simulation will use these values for the check's scanned MICR data.
19
+ # If not set, the simulation will use random values.
19
20
  #
20
21
  # @return [Increase::Models::Simulations::CheckDepositSubmitParams::Scan, nil]
21
22
  optional :scan, -> { Increase::Simulations::CheckDepositSubmitParams::Scan }
22
23
 
23
24
  # @!method initialize(check_deposit_id:, scan: nil, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {Increase::Models::Simulations::CheckDepositSubmitParams} for more details.
27
+ #
24
28
  # @param check_deposit_id [String] The identifier of the Check Deposit you wish to submit.
25
29
  #
26
30
  # @param scan [Increase::Models::Simulations::CheckDepositSubmitParams::Scan] If set, the simulation will use these values for the check's scanned MICR data.
@@ -42,18 +46,33 @@ module Increase
42
46
 
43
47
  # @!attribute auxiliary_on_us
44
48
  # The auxiliary on-us data to be returned in the check deposit's scan data.
49
+ # Auxiliary on-us is typically the check number for business checks.
45
50
  #
46
51
  # @return [String, nil]
47
52
  optional :auxiliary_on_us, String
48
53
 
49
- # @!method initialize(account_number:, routing_number:, auxiliary_on_us: nil)
54
+ # @!attribute serial_number
55
+ # The serial number to be returned in the check deposit's scan data. Serial number
56
+ # is typically the check number for consumer checks.
57
+ #
58
+ # @return [String, nil]
59
+ optional :serial_number, String
60
+
61
+ # @!method initialize(account_number:, routing_number:, auxiliary_on_us: nil, serial_number: nil)
62
+ # Some parameter documentations has been truncated, see
63
+ # {Increase::Models::Simulations::CheckDepositSubmitParams::Scan} for more
64
+ # details.
65
+ #
50
66
  # If set, the simulation will use these values for the check's scanned MICR data.
67
+ # If not set, the simulation will use random values.
51
68
  #
52
69
  # @param account_number [String] The account number to be returned in the check deposit's scan data.
53
70
  #
54
71
  # @param routing_number [String] The routing number to be returned in the check deposit's scan data.
55
72
  #
56
- # @param auxiliary_on_us [String] The auxiliary on-us data to be returned in the check deposit's scan data.
73
+ # @param auxiliary_on_us [String] The auxiliary on-us data to be returned in the check deposit's scan data. Auxili
74
+ #
75
+ # @param serial_number [String] The serial number to be returned in the check deposit's scan data. Serial number
57
76
  end
58
77
  end
59
78
  end
@@ -60,6 +60,12 @@ module Increase
60
60
  # Your webhook declined the token provisioning attempt.
61
61
  WEBHOOK_DECLINED = :webhook_declined
62
62
 
63
+ # The tokenization attempt failed because the Card Verification Code (CVC) was incorrect.
64
+ INCORRECT_CARD_VERIFICATION_CODE = :incorrect_card_verification_code
65
+
66
+ # The tokenization attempt was declined by the token requestor.
67
+ DECLINED_BY_TOKEN_REQUESTOR = :declined_by_token_requestor
68
+
63
69
  # @!method self.values
64
70
  # @return [Array<Symbol>]
65
71
  end