increase 1.349.0 → 1.350.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 (134) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_number.rb +3 -3
  4. data/lib/increase/models/ach_transfer.rb +12 -12
  5. data/lib/increase/models/balance_lookup.rb +1 -1
  6. data/lib/increase/models/beneficial_owner_create_params.rb +2 -4
  7. data/lib/increase/models/beneficial_owner_update_params.rb +2 -4
  8. data/lib/increase/models/card_dispute.rb +9 -1
  9. data/lib/increase/models/card_dispute_submit_user_submission_params.rb +4 -0
  10. data/lib/increase/models/card_payment.rb +58 -58
  11. data/lib/increase/models/card_purchase_supplement.rb +9 -1
  12. data/lib/increase/models/card_token_capabilities.rb +2 -2
  13. data/lib/increase/models/check_deposit.rb +9 -9
  14. data/lib/increase/models/check_transfer.rb +2 -2
  15. data/lib/increase/models/check_transfer_create_params.rb +9 -4
  16. data/lib/increase/models/declined_transaction.rb +12 -9
  17. data/lib/increase/models/digital_wallet_token.rb +9 -1
  18. data/lib/increase/models/entity.rb +5 -5
  19. data/lib/increase/models/entity_create_params.rb +332 -29
  20. data/lib/increase/models/entity_onboarding_session_list_params.rb +2 -2
  21. data/lib/increase/models/entity_update_params.rb +472 -15
  22. data/lib/increase/models/fednow_transfer.rb +115 -4
  23. data/lib/increase/models/fednow_transfer_list_params.rb +3 -3
  24. data/lib/increase/models/inbound_ach_transfer.rb +2 -2
  25. data/lib/increase/models/inbound_check_deposit.rb +2 -2
  26. data/lib/increase/models/inbound_fednow_transfer.rb +3 -0
  27. data/lib/increase/models/inbound_mail_item.rb +14 -1
  28. data/lib/increase/models/inbound_wire_drawdown_request.rb +12 -1
  29. data/lib/increase/models/inbound_wire_transfer.rb +4 -4
  30. data/lib/increase/models/intrafi_exclusion.rb +4 -4
  31. data/lib/increase/models/lockbox_recipient_create_params.rb +2 -2
  32. data/lib/increase/models/pending_transaction.rb +13 -13
  33. data/lib/increase/models/pending_transaction_list_params.rb +4 -6
  34. data/lib/increase/models/physical_card.rb +9 -1
  35. data/lib/increase/models/real_time_decision.rb +18 -18
  36. data/lib/increase/models/simulations/card_authentication_create_params.rb +2 -2
  37. data/lib/increase/models/simulations/card_dispute_action_params.rb +6 -6
  38. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -3
  39. data/lib/increase/models/simulations/interest_payment_create_params.rb +2 -2
  40. data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +2 -2
  41. data/lib/increase/models/simulations/program_create_params.rb +14 -3
  42. data/lib/increase/models/transaction.rb +141 -17
  43. data/lib/increase/models/transaction_list_params.rb +3 -0
  44. data/lib/increase/models/wire_drawdown_request.rb +12 -1
  45. data/lib/increase/models/wire_transfer_create_params.rb +2 -2
  46. data/lib/increase/resources/cards.rb +2 -2
  47. data/lib/increase/resources/check_transfers.rb +1 -1
  48. data/lib/increase/resources/entities.rb +10 -2
  49. data/lib/increase/resources/entity_onboarding_sessions.rb +1 -1
  50. data/lib/increase/resources/lockbox_recipients.rb +1 -1
  51. data/lib/increase/resources/simulations/card_authentications.rb +1 -1
  52. data/lib/increase/resources/simulations/card_disputes.rb +2 -2
  53. data/lib/increase/resources/simulations/interest_payments.rb +1 -1
  54. data/lib/increase/resources/simulations/pending_transactions.rb +1 -1
  55. data/lib/increase/resources/simulations/physical_cards.rb +2 -2
  56. data/lib/increase/resources/simulations/programs.rb +6 -2
  57. data/lib/increase/resources/wire_transfers.rb +1 -1
  58. data/lib/increase/version.rb +1 -1
  59. data/rbi/increase/models/account_number.rbi +3 -3
  60. data/rbi/increase/models/ach_transfer.rbi +12 -12
  61. data/rbi/increase/models/balance_lookup.rbi +1 -1
  62. data/rbi/increase/models/beneficial_owner_create_params.rbi +2 -4
  63. data/rbi/increase/models/beneficial_owner_update_params.rbi +2 -4
  64. data/rbi/increase/models/card_dispute.rbi +8 -0
  65. data/rbi/increase/models/card_dispute_submit_user_submission_params.rbi +3 -0
  66. data/rbi/increase/models/card_payment.rbi +58 -58
  67. data/rbi/increase/models/card_purchase_supplement.rbi +8 -0
  68. data/rbi/increase/models/card_token_capabilities.rbi +2 -2
  69. data/rbi/increase/models/check_deposit.rbi +9 -9
  70. data/rbi/increase/models/check_transfer.rbi +2 -2
  71. data/rbi/increase/models/check_transfer_create_params.rbi +8 -4
  72. data/rbi/increase/models/declined_transaction.rbi +16 -9
  73. data/rbi/increase/models/digital_wallet_token.rbi +8 -0
  74. data/rbi/increase/models/entity.rbi +5 -5
  75. data/rbi/increase/models/entity_create_params.rbi +547 -28
  76. data/rbi/increase/models/entity_onboarding_session_list_params.rbi +2 -2
  77. data/rbi/increase/models/entity_update_params.rbi +814 -14
  78. data/rbi/increase/models/fednow_transfer.rbi +213 -7
  79. data/rbi/increase/models/fednow_transfer_list_params.rbi +7 -7
  80. data/rbi/increase/models/inbound_ach_transfer.rbi +2 -2
  81. data/rbi/increase/models/inbound_check_deposit.rbi +2 -2
  82. data/rbi/increase/models/inbound_fednow_transfer.rbi +7 -0
  83. data/rbi/increase/models/inbound_mail_item.rbi +12 -0
  84. data/rbi/increase/models/inbound_wire_drawdown_request.rbi +10 -0
  85. data/rbi/increase/models/inbound_wire_transfer.rbi +4 -4
  86. data/rbi/increase/models/intrafi_exclusion.rbi +4 -4
  87. data/rbi/increase/models/lockbox_recipient_create_params.rbi +2 -2
  88. data/rbi/increase/models/pending_transaction.rbi +13 -13
  89. data/rbi/increase/models/pending_transaction_list_params.rbi +4 -6
  90. data/rbi/increase/models/physical_card.rbi +8 -0
  91. data/rbi/increase/models/real_time_decision.rbi +18 -18
  92. data/rbi/increase/models/simulations/card_authentication_create_params.rbi +2 -2
  93. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +6 -6
  94. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +3 -3
  95. data/rbi/increase/models/simulations/interest_payment_create_params.rbi +2 -2
  96. data/rbi/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rbi +2 -2
  97. data/rbi/increase/models/simulations/program_create_params.rbi +15 -2
  98. data/rbi/increase/models/transaction.rbi +260 -16
  99. data/rbi/increase/models/transaction_list_params.rbi +7 -0
  100. data/rbi/increase/models/wire_drawdown_request.rbi +10 -0
  101. data/rbi/increase/models/wire_transfer_create_params.rbi +2 -2
  102. data/rbi/increase/resources/cards.rbi +2 -2
  103. data/rbi/increase/resources/check_transfers.rbi +1 -1
  104. data/rbi/increase/resources/entities.rbi +10 -0
  105. data/rbi/increase/resources/entity_onboarding_sessions.rbi +1 -1
  106. data/rbi/increase/resources/lockbox_recipients.rbi +1 -1
  107. data/rbi/increase/resources/simulations/card_authentications.rbi +1 -1
  108. data/rbi/increase/resources/simulations/card_disputes.rbi +2 -2
  109. data/rbi/increase/resources/simulations/interest_payments.rbi +1 -1
  110. data/rbi/increase/resources/simulations/pending_transactions.rbi +1 -1
  111. data/rbi/increase/resources/simulations/physical_cards.rbi +2 -2
  112. data/rbi/increase/resources/simulations/programs.rbi +5 -1
  113. data/rbi/increase/resources/wire_transfers.rbi +1 -1
  114. data/sig/increase/models/card_dispute.rbs +5 -0
  115. data/sig/increase/models/card_purchase_supplement.rbs +5 -0
  116. data/sig/increase/models/declined_transaction.rbs +4 -0
  117. data/sig/increase/models/digital_wallet_token.rbs +5 -0
  118. data/sig/increase/models/entity.rbs +3 -3
  119. data/sig/increase/models/entity_create_params.rbs +232 -1
  120. data/sig/increase/models/entity_update_params.rbs +366 -0
  121. data/sig/increase/models/fednow_transfer.rbs +113 -4
  122. data/sig/increase/models/fednow_transfer_list_params.rbs +4 -4
  123. data/sig/increase/models/inbound_fednow_transfer.rbs +4 -0
  124. data/sig/increase/models/inbound_mail_item.rbs +5 -0
  125. data/sig/increase/models/inbound_wire_drawdown_request.rbs +5 -0
  126. data/sig/increase/models/physical_card.rbs +5 -0
  127. data/sig/increase/models/simulations/entity_update_validation_params.rbs +3 -3
  128. data/sig/increase/models/simulations/program_create_params.rbs +7 -0
  129. data/sig/increase/models/transaction.rbs +113 -0
  130. data/sig/increase/models/transaction_list_params.rbs +4 -0
  131. data/sig/increase/models/wire_drawdown_request.rbs +5 -0
  132. data/sig/increase/resources/entities.rbs +2 -0
  133. data/sig/increase/resources/simulations/programs.rbs +1 -0
  134. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 23cf98582ddaa22a0c6fcea1ae351f11324ff09dd6fc637883436dda459fe05c
4
- data.tar.gz: 92fadfd622e3083e74f486cdbb8910d7021146294aa824c671edfbd7c35fdd7f
3
+ metadata.gz: adebb64c6cd675fc86e8f775270247fd1f157a16d392b9c754a7e1c0c7938110
4
+ data.tar.gz: 6b39d876b4891952467d186091578d6931a5a2fd5e7d0d4d743d6c1ace4a17f9
5
5
  SHA512:
6
- metadata.gz: 18170e8cff606f8ef8248eb56d106e6ecac5a7c123b351505a02cef6836dbf2f1ab459122872c136f8c50c08e62c092529cbafc73018ae3157469939d0c1b86d
7
- data.tar.gz: 34c18ed49cc6b7ad16bdac6a4dae2bb364e22387fd50554635bc71ab2a926eb7db67c8200cea3f691f64eff52a1dcaa342686a8a4e581bc10c411dfa7eaca69a
6
+ metadata.gz: 2eca8b8f5625cc74161ccb7d7a0f2ad0013a60697508f00f78ae5f2e37ed3d4c23f7075b01e9f608698d0e11a64d9342253de4e3dee3d6df241f3091fc60c214
7
+ data.tar.gz: 11b583edd8100371cda43b93f2f0d625e30be93c8ef3ea68f50f15e2c684669f6aa7d6b172940028ed92feede0856ac544c80b169d641081c20c4634f54e0c0e
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.349.0"
18
+ gem "increase", "~> 1.350.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -119,7 +119,7 @@ module Increase
119
119
  class InboundACH < Increase::Internal::Type::BaseModel
120
120
  # @!attribute debit_status
121
121
  # Whether ACH debits are allowed against this Account Number. Note that they will
122
- # still be declined if this is `allowed` if the Account Number is not active.
122
+ # still be declined if this is `allowed` but the Account Number is not active.
123
123
  #
124
124
  # @return [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus]
125
125
  required :debit_status, enum: -> { Increase::AccountNumber::InboundACH::DebitStatus }
@@ -129,10 +129,10 @@ module Increase
129
129
  #
130
130
  # @param debit_status [Symbol, Increase::Models::AccountNumber::InboundACH::DebitStatus]
131
131
  # Whether ACH debits are allowed against this Account Number. Note that they will
132
- # still be declined if this is `allowed` if the Account Number is not active.
132
+ # still be declined if this is `allowed` but the Account Number is not active.
133
133
 
134
134
  # Whether ACH debits are allowed against this Account Number. Note that they will
135
- # still be declined if this is `allowed` if the Account Number is not active.
135
+ # still be declined if this is `allowed` but the Account Number is not active.
136
136
  #
137
137
  # @see Increase::Models::AccountNumber::InboundACH#debit_status
138
138
  module DebitStatus
@@ -1496,12 +1496,12 @@ module Increase
1496
1496
  # @see Increase::Models::ACHTransfer#submission
1497
1497
  class Submission < Increase::Internal::Type::BaseModel
1498
1498
  # @!attribute administrative_returns_expected_by
1499
- # The timestamp by which any administrative returns are expected to be received
1500
- # by. This follows the Nacha guidelines for return windows, which are: "In
1501
- # general, return entries must be received by the RDFI’s ACH Operator by its
1502
- # deposit deadline for the return entry to be made available to the ODFI no later
1503
- # than the opening of business on the second banking day following the Settlement
1504
- # Date of the original entry.".
1499
+ # The timestamp by which any administrative returns are expected to be received.
1500
+ # This follows the Nacha guidelines for return windows, which are: "In general,
1501
+ # return entries must be received by the RDFI’s ACH Operator by its deposit
1502
+ # deadline for the return entry to be made available to the ODFI no later than the
1503
+ # opening of business on the second banking day following the Settlement Date of
1504
+ # the original entry.".
1505
1505
  #
1506
1506
  # @return [Time]
1507
1507
  required :administrative_returns_expected_by, Time
@@ -1557,12 +1557,12 @@ module Increase
1557
1557
  # [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
1558
1558
  #
1559
1559
  # @param administrative_returns_expected_by [Time]
1560
- # The timestamp by which any administrative returns are expected to be received
1561
- # by. This follows the Nacha guidelines for return windows, which are: "In
1562
- # general, return entries must be received by the RDFI’s ACH Operator by its
1563
- # deposit deadline for the return entry to be made available to the ODFI no later
1564
- # than the opening of business on the second banking day following the Settlement
1565
- # Date of the original entry.".
1560
+ # The timestamp by which any administrative returns are expected to be received.
1561
+ # This follows the Nacha guidelines for return windows, which are: "In general,
1562
+ # return entries must be received by the RDFI’s ACH Operator by its deposit
1563
+ # deadline for the return entry to be made available to the ODFI no later than the
1564
+ # opening of business on the second banking day following the Settlement Date of
1565
+ # the original entry.".
1566
1566
  #
1567
1567
  # @param effective_date [Date]
1568
1568
  # The ACH transfer's effective date as sent to the Federal Reserve. If a specific
@@ -38,7 +38,7 @@ module Increase
38
38
  required :type, enum: -> { Increase::BalanceLookup::Type }
39
39
 
40
40
  # @!method initialize(account_id:, available_balance:, current_balance:, loan:, type:)
41
- # Represents a request to lookup the balance of an Account at a given point in
41
+ # Represents a request to look up the balance of an Account at a given point in
42
42
  # time.
43
43
  #
44
44
  # @param account_id [String] The identifier for the account for which the balance was queried.
@@ -186,8 +186,7 @@ module Increase
186
186
  # An identification number that can be used to verify the individual's identity,
187
187
  # such as a social security number. For Social Security Numbers and Individual
188
188
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
189
- # separators. When testing in sandbox, use one of our
190
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
189
+ # separators.
191
190
  #
192
191
  # @return [String]
193
192
  required :number, String
@@ -226,8 +225,7 @@ module Increase
226
225
  # An identification number that can be used to verify the individual's identity,
227
226
  # such as a social security number. For Social Security Numbers and Individual
228
227
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
229
- # separators. When testing in sandbox, use one of our
230
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
228
+ # separators.
231
229
  #
232
230
  # @param drivers_license [Increase::Models::BeneficialOwnerCreateParams::Individual::Identification::DriversLicense]
233
231
  # Information about the United States driver's license used for identification.
@@ -162,8 +162,7 @@ module Increase
162
162
  # An identification number that can be used to verify the individual's identity,
163
163
  # such as a social security number. For Social Security Numbers and Individual
164
164
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
165
- # separators. When testing in sandbox, use one of our
166
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
165
+ # separators.
167
166
  #
168
167
  # @return [String]
169
168
  required :number, String
@@ -201,8 +200,7 @@ module Increase
201
200
  # An identification number that can be used to verify the individual's identity,
202
201
  # such as a social security number. For Social Security Numbers and Individual
203
202
  # Taxpayer Identification Numbers, submit nine digits with no dashes or other
204
- # separators. When testing in sandbox, use one of our
205
- # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
203
+ # separators.
206
204
  #
207
205
  # @param drivers_license [Increase::Models::BeneficialOwnerUpdateParams::Identification::DriversLicense]
208
206
  # Information about the United States driver's license used for identification.
@@ -10,6 +10,12 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_id
14
+ # The Account that the Card Dispute is associated with.
15
+ #
16
+ # @return [String]
17
+ required :account_id, String
18
+
13
19
  # @!attribute amount
14
20
  # The amount of the dispute.
15
21
  #
@@ -107,12 +113,14 @@ module Increase
107
113
  # @return [Increase::Models::CardDispute::Withdrawal, nil]
108
114
  required :withdrawal, -> { Increase::CardDispute::Withdrawal }, nil?: true
109
115
 
110
- # @!method initialize(id:, amount:, card_id:, created_at:, disputed_transaction_id:, idempotency_key:, loss:, network:, rejection:, status:, type:, user_submission_required_by:, visa:, win:, withdrawal:)
116
+ # @!method initialize(id:, account_id:, amount:, card_id:, created_at:, disputed_transaction_id:, idempotency_key:, loss:, network:, rejection:, status:, type:, user_submission_required_by:, visa:, win:, withdrawal:)
111
117
  # If unauthorized activity occurs on a card, you can create a Card Dispute and
112
118
  # we'll work with the card networks to return the funds if appropriate.
113
119
  #
114
120
  # @param id [String] The Card Dispute identifier.
115
121
  #
122
+ # @param account_id [String] The Account that the Card Dispute is associated with.
123
+ #
116
124
  # @param amount [Integer] The amount of the dispute.
117
125
  #
118
126
  # @param card_id [String] The Card that the Card Dispute is associated with.
@@ -3573,6 +3573,7 @@ module Increase
3573
3573
  # @see Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa::UserPrearbitration#category_change
3574
3574
  class CategoryChange < Increase::Internal::Type::BaseModel
3575
3575
  # @!attribute category
3576
+ # The category the dispute is being changed to.
3576
3577
  #
3577
3578
  # @return [Symbol, Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa::UserPrearbitration::CategoryChange::Category]
3578
3579
  required :category,
@@ -3590,9 +3591,12 @@ module Increase
3590
3591
  # pre-arbitration request.
3591
3592
  #
3592
3593
  # @param category [Symbol, Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa::UserPrearbitration::CategoryChange::Category]
3594
+ # The category the dispute is being changed to.
3593
3595
  #
3594
3596
  # @param reason [String] The reason for the category change.
3595
3597
 
3598
+ # The category the dispute is being changed to.
3599
+ #
3596
3600
  # @see Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa::UserPrearbitration::CategoryChange#category
3597
3601
  module Category
3598
3602
  extend Increase::Internal::Type::Enum
@@ -1387,9 +1387,9 @@ module Increase
1387
1387
  required :actioner, enum: -> { Increase::CardPayment::Element::CardAuthorization::Actioner }
1388
1388
 
1389
1389
  # @!attribute additional_amounts
1390
- # Additional amounts associated with the card authorization, such as ATM
1391
- # surcharges fees. These are usually a subset of the `amount` field and are used
1392
- # to provide more detailed information about the transaction.
1390
+ # Additional amounts associated with the card authorization, such as ATM surcharge
1391
+ # fees. These are usually a subset of the `amount` field and are used to provide
1392
+ # more detailed information about the transaction.
1393
1393
  #
1394
1394
  # @return [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts]
1395
1395
  required :additional_amounts, -> { Increase::CardPayment::Element::CardAuthorization::AdditionalAmounts }
@@ -1429,8 +1429,8 @@ module Increase
1429
1429
  required :direction, enum: -> { Increase::CardPayment::Element::CardAuthorization::Direction }
1430
1430
 
1431
1431
  # @!attribute expires_at
1432
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
1433
- # will expire and the pending transaction will be released.
1432
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which this
1433
+ # authorization will expire and the pending transaction will be released.
1434
1434
  #
1435
1435
  # @return [Time]
1436
1436
  required :expires_at, Time
@@ -1603,9 +1603,9 @@ module Increase
1603
1603
  # stand-in processing, or the user through a real-time decision.
1604
1604
  #
1605
1605
  # @param additional_amounts [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts]
1606
- # Additional amounts associated with the card authorization, such as ATM
1607
- # surcharges fees. These are usually a subset of the `amount` field and are used
1608
- # to provide more detailed information about the transaction.
1606
+ # Additional amounts associated with the card authorization, such as ATM surcharge
1607
+ # fees. These are usually a subset of the `amount` field and are used to provide
1608
+ # more detailed information about the transaction.
1609
1609
  #
1610
1610
  # @param amount [Integer]
1611
1611
  # The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -1626,8 +1626,8 @@ module Increase
1626
1626
  # cardholder to the merchant or from the merchant to the cardholder.
1627
1627
  #
1628
1628
  # @param expires_at [Time]
1629
- # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
1630
- # will expire and the pending transaction will be released.
1629
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which this
1630
+ # authorization will expire and the pending transaction will be released.
1631
1631
  #
1632
1632
  # @param healthcare [Increase::Models::CardPayment::Element::CardAuthorization::Healthcare, nil]
1633
1633
  # The healthcare-related fields for this authorization. Only present for specific
@@ -1816,9 +1816,9 @@ module Increase
1816
1816
  nil?: true
1817
1817
 
1818
1818
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
1819
- # Additional amounts associated with the card authorization, such as ATM
1820
- # surcharges fees. These are usually a subset of the `amount` field and are used
1821
- # to provide more detailed information about the transaction.
1819
+ # Additional amounts associated with the card authorization, such as ATM surcharge
1820
+ # fees. These are usually a subset of the `amount` field and are used to provide
1821
+ # more detailed information about the transaction.
1822
1822
  #
1823
1823
  # @param clinic [Increase::Models::CardPayment::Element::CardAuthorization::AdditionalAmounts::Clinic, nil]
1824
1824
  # The part of this transaction amount that was for clinic-related services.
@@ -3111,9 +3111,9 @@ module Increase
3111
3111
  required :id, String
3112
3112
 
3113
3113
  # @!attribute additional_amounts
3114
- # Additional amounts associated with the card authorization, such as ATM
3115
- # surcharges fees. These are usually a subset of the `amount` field and are used
3116
- # to provide more detailed information about the transaction.
3114
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3115
+ # fees. These are usually a subset of the `amount` field and are used to provide
3116
+ # more detailed information about the transaction.
3117
3117
  #
3118
3118
  # @return [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts]
3119
3119
  required :additional_amounts, -> { Increase::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts }
@@ -3262,9 +3262,9 @@ module Increase
3262
3262
  # @param id [String] The Card Balance Inquiry identifier.
3263
3263
  #
3264
3264
  # @param additional_amounts [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts]
3265
- # Additional amounts associated with the card authorization, such as ATM
3266
- # surcharges fees. These are usually a subset of the `amount` field and are used
3267
- # to provide more detailed information about the transaction.
3265
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3266
+ # fees. These are usually a subset of the `amount` field and are used to provide
3267
+ # more detailed information about the transaction.
3268
3268
  #
3269
3269
  # @param balance [Integer]
3270
3270
  # The balance amount in the minor unit of the account's currency. For dollars, for
@@ -3422,9 +3422,9 @@ module Increase
3422
3422
  nil?: true
3423
3423
 
3424
3424
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
3425
- # Additional amounts associated with the card authorization, such as ATM
3426
- # surcharges fees. These are usually a subset of the `amount` field and are used
3427
- # to provide more detailed information about the transaction.
3425
+ # Additional amounts associated with the card authorization, such as ATM surcharge
3426
+ # fees. These are usually a subset of the `amount` field and are used to provide
3427
+ # more detailed information about the transaction.
3428
3428
  #
3429
3429
  # @param clinic [Increase::Models::CardPayment::Element::CardBalanceInquiry::AdditionalAmounts::Clinic, nil]
3430
3430
  # The part of this transaction amount that was for clinic-related services.
@@ -4509,9 +4509,9 @@ module Increase
4509
4509
  required :actioner, enum: -> { Increase::CardPayment::Element::CardDecline::Actioner }
4510
4510
 
4511
4511
  # @!attribute additional_amounts
4512
- # Additional amounts associated with the card authorization, such as ATM
4513
- # surcharges fees. These are usually a subset of the `amount` field and are used
4514
- # to provide more detailed information about the transaction.
4512
+ # Additional amounts associated with the card authorization, such as ATM surcharge
4513
+ # fees. These are usually a subset of the `amount` field and are used to provide
4514
+ # more detailed information about the transaction.
4515
4515
  #
4516
4516
  # @return [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts]
4517
4517
  required :additional_amounts, -> { Increase::CardPayment::Element::CardDecline::AdditionalAmounts }
@@ -4709,9 +4709,9 @@ module Increase
4709
4709
  # stand-in processing, or the user through a real-time decision.
4710
4710
  #
4711
4711
  # @param additional_amounts [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts]
4712
- # Additional amounts associated with the card authorization, such as ATM
4713
- # surcharges fees. These are usually a subset of the `amount` field and are used
4714
- # to provide more detailed information about the transaction.
4712
+ # Additional amounts associated with the card authorization, such as ATM surcharge
4713
+ # fees. These are usually a subset of the `amount` field and are used to provide
4714
+ # more detailed information about the transaction.
4715
4715
  #
4716
4716
  # @param amount [Integer]
4717
4717
  # The declined amount in the minor unit of the destination account currency. For
@@ -4908,9 +4908,9 @@ module Increase
4908
4908
  nil?: true
4909
4909
 
4910
4910
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
4911
- # Additional amounts associated with the card authorization, such as ATM
4912
- # surcharges fees. These are usually a subset of the `amount` field and are used
4913
- # to provide more detailed information about the transaction.
4911
+ # Additional amounts associated with the card authorization, such as ATM surcharge
4912
+ # fees. These are usually a subset of the `amount` field and are used to provide
4913
+ # more detailed information about the transaction.
4914
4914
  #
4915
4915
  # @param clinic [Increase::Models::CardPayment::Element::CardDecline::AdditionalAmounts::Clinic, nil]
4916
4916
  # The part of this transaction amount that was for clinic-related services.
@@ -6148,9 +6148,9 @@ module Increase
6148
6148
  required :actioner, enum: -> { Increase::CardPayment::Element::CardFinancial::Actioner }
6149
6149
 
6150
6150
  # @!attribute additional_amounts
6151
- # Additional amounts associated with the card authorization, such as ATM
6152
- # surcharges fees. These are usually a subset of the `amount` field and are used
6153
- # to provide more detailed information about the transaction.
6151
+ # Additional amounts associated with the card authorization, such as ATM surcharge
6152
+ # fees. These are usually a subset of the `amount` field and are used to provide
6153
+ # more detailed information about the transaction.
6154
6154
  #
6155
6155
  # @return [Increase::Models::CardPayment::Element::CardFinancial::AdditionalAmounts]
6156
6156
  required :additional_amounts, -> { Increase::CardPayment::Element::CardFinancial::AdditionalAmounts }
@@ -6336,9 +6336,9 @@ module Increase
6336
6336
  # stand-in processing, or the user through a real-time decision.
6337
6337
  #
6338
6338
  # @param additional_amounts [Increase::Models::CardPayment::Element::CardFinancial::AdditionalAmounts]
6339
- # Additional amounts associated with the card authorization, such as ATM
6340
- # surcharges fees. These are usually a subset of the `amount` field and are used
6341
- # to provide more detailed information about the transaction.
6339
+ # Additional amounts associated with the card authorization, such as ATM surcharge
6340
+ # fees. These are usually a subset of the `amount` field and are used to provide
6341
+ # more detailed information about the transaction.
6342
6342
  #
6343
6343
  # @param amount [Integer]
6344
6344
  # The pending amount in the minor unit of the transaction's currency. For dollars,
@@ -6527,9 +6527,9 @@ module Increase
6527
6527
  nil?: true
6528
6528
 
6529
6529
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
6530
- # Additional amounts associated with the card authorization, such as ATM
6531
- # surcharges fees. These are usually a subset of the `amount` field and are used
6532
- # to provide more detailed information about the transaction.
6530
+ # Additional amounts associated with the card authorization, such as ATM surcharge
6531
+ # fees. These are usually a subset of the `amount` field and are used to provide
6532
+ # more detailed information about the transaction.
6533
6533
  #
6534
6534
  # @param clinic [Increase::Models::CardPayment::Element::CardFinancial::AdditionalAmounts::Clinic, nil]
6535
6535
  # The part of this transaction amount that was for clinic-related services.
@@ -8049,9 +8049,9 @@ module Increase
8049
8049
  required :actioner, enum: -> { Increase::CardPayment::Element::CardIncrement::Actioner }
8050
8050
 
8051
8051
  # @!attribute additional_amounts
8052
- # Additional amounts associated with the card authorization, such as ATM
8053
- # surcharges fees. These are usually a subset of the `amount` field and are used
8054
- # to provide more detailed information about the transaction.
8052
+ # Additional amounts associated with the card authorization, such as ATM surcharge
8053
+ # fees. These are usually a subset of the `amount` field and are used to provide
8054
+ # more detailed information about the transaction.
8055
8055
  #
8056
8056
  # @return [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts]
8057
8057
  required :additional_amounts, -> { Increase::CardPayment::Element::CardIncrement::AdditionalAmounts }
@@ -8155,9 +8155,9 @@ module Increase
8155
8155
  # stand-in processing, or the user through a real-time decision.
8156
8156
  #
8157
8157
  # @param additional_amounts [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts]
8158
- # Additional amounts associated with the card authorization, such as ATM
8159
- # surcharges fees. These are usually a subset of the `amount` field and are used
8160
- # to provide more detailed information about the transaction.
8158
+ # Additional amounts associated with the card authorization, such as ATM surcharge
8159
+ # fees. These are usually a subset of the `amount` field and are used to provide
8160
+ # more detailed information about the transaction.
8161
8161
  #
8162
8162
  # @param amount [Integer]
8163
8163
  # The amount of this increment in the minor unit of the transaction's currency.
@@ -8308,9 +8308,9 @@ module Increase
8308
8308
  nil?: true
8309
8309
 
8310
8310
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
8311
- # Additional amounts associated with the card authorization, such as ATM
8312
- # surcharges fees. These are usually a subset of the `amount` field and are used
8313
- # to provide more detailed information about the transaction.
8311
+ # Additional amounts associated with the card authorization, such as ATM surcharge
8312
+ # fees. These are usually a subset of the `amount` field and are used to provide
8313
+ # more detailed information about the transaction.
8314
8314
  #
8315
8315
  # @param clinic [Increase::Models::CardPayment::Element::CardIncrement::AdditionalAmounts::Clinic, nil]
8316
8316
  # The part of this transaction amount that was for clinic-related services.
@@ -12674,9 +12674,9 @@ module Increase
12674
12674
  required :actioner, enum: -> { Increase::CardPayment::Element::CardValidation::Actioner }
12675
12675
 
12676
12676
  # @!attribute additional_amounts
12677
- # Additional amounts associated with the card authorization, such as ATM
12678
- # surcharges fees. These are usually a subset of the `amount` field and are used
12679
- # to provide more detailed information about the transaction.
12677
+ # Additional amounts associated with the card authorization, such as ATM surcharge
12678
+ # fees. These are usually a subset of the `amount` field and are used to provide
12679
+ # more detailed information about the transaction.
12680
12680
  #
12681
12681
  # @return [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts]
12682
12682
  required :additional_amounts, -> { Increase::CardPayment::Element::CardValidation::AdditionalAmounts }
@@ -12820,9 +12820,9 @@ module Increase
12820
12820
  # stand-in processing, or the user through a real-time decision.
12821
12821
  #
12822
12822
  # @param additional_amounts [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts]
12823
- # Additional amounts associated with the card authorization, such as ATM
12824
- # surcharges fees. These are usually a subset of the `amount` field and are used
12825
- # to provide more detailed information about the transaction.
12823
+ # Additional amounts associated with the card authorization, such as ATM surcharge
12824
+ # fees. These are usually a subset of the `amount` field and are used to provide
12825
+ # more detailed information about the transaction.
12826
12826
  #
12827
12827
  # @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
12828
12828
  #
@@ -12994,9 +12994,9 @@ module Increase
12994
12994
  nil?: true
12995
12995
 
12996
12996
  # @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
12997
- # Additional amounts associated with the card authorization, such as ATM
12998
- # surcharges fees. These are usually a subset of the `amount` field and are used
12999
- # to provide more detailed information about the transaction.
12997
+ # Additional amounts associated with the card authorization, such as ATM surcharge
12998
+ # fees. These are usually a subset of the `amount` field and are used to provide
12999
+ # more detailed information about the transaction.
13000
13000
  #
13001
13001
  # @param clinic [Increase::Models::CardPayment::Element::CardValidation::AdditionalAmounts::Clinic, nil]
13002
13002
  # The part of this transaction amount that was for clinic-related services.
@@ -10,6 +10,12 @@ module Increase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute account_id
14
+ # The identifier for the Account the Card Purchase Supplement belongs to.
15
+ #
16
+ # @return [String]
17
+ required :account_id, String
18
+
13
19
  # @!attribute card_payment_id
14
20
  # The ID of the Card Payment this transaction belongs to.
15
21
  #
@@ -49,12 +55,14 @@ module Increase
49
55
  # @return [Symbol, Increase::Models::CardPurchaseSupplement::Type]
50
56
  required :type, enum: -> { Increase::CardPurchaseSupplement::Type }
51
57
 
52
- # @!method initialize(id:, card_payment_id:, invoice:, line_items:, shipping:, transaction_id:, type:)
58
+ # @!method initialize(id:, account_id:, card_payment_id:, invoice:, line_items:, shipping:, transaction_id:, type:)
53
59
  # Additional information about a card purchase (e.g., settlement or refund), such
54
60
  # as level 3 line item data.
55
61
  #
56
62
  # @param id [String] The Card Purchase Supplement identifier.
57
63
  #
64
+ # @param account_id [String] The identifier for the Account the Card Purchase Supplement belongs to.
65
+ #
58
66
  # @param card_payment_id [String, nil] The ID of the Card Payment this transaction belongs to.
59
67
  #
60
68
  # @param invoice [Increase::Models::CardPurchaseSupplement::Invoice, nil]
@@ -5,7 +5,7 @@ module Increase
5
5
  # @see Increase::Resources::CardTokens#capabilities
6
6
  class CardTokenCapabilities < Increase::Internal::Type::BaseModel
7
7
  # @!attribute routes
8
- # Each route represent a path e.g., a push transfer can take.
8
+ # Each route represents a path e.g., a push transfer can take.
9
9
  #
10
10
  # @return [Array<Increase::Models::CardTokenCapabilities::Route>]
11
11
  required :routes, -> { Increase::Internal::Type::ArrayOf[Increase::CardTokenCapabilities::Route] }
@@ -23,7 +23,7 @@ module Increase
23
23
  # over time based on the issuing bank's configuration of the card range.
24
24
  #
25
25
  # @param routes [Array<Increase::Models::CardTokenCapabilities::Route>]
26
- # Each route represent a path e.g., a push transfer can take.
26
+ # Each route represents a path e.g., a push transfer can take.
27
27
  #
28
28
  # @param type [Symbol, Increase::Models::CardTokenCapabilities::Type]
29
29
  # A constant representing the object's type. For this resource it will always be
@@ -65,7 +65,7 @@ module Increase
65
65
  required :deposit_return, -> { Increase::CheckDeposit::DepositReturn }, nil?: true
66
66
 
67
67
  # @!attribute deposit_submission
68
- # After the check is parsed, it is submitted to the Check21 network for
68
+ # After the check is parsed, it is submitted to the Check 21 network for
69
69
  # processing. This will contain details of the submission.
70
70
  #
71
71
  # @return [Increase::Models::CheckDeposit::DepositSubmission, nil]
@@ -164,7 +164,7 @@ module Increase
164
164
  # returned.
165
165
  #
166
166
  # @param deposit_submission [Increase::Models::CheckDeposit::DepositSubmission, nil]
167
- # After the check is parsed, it is submitted to the Check21 network for
167
+ # After the check is parsed, it is submitted to the Check 21 network for
168
168
  # processing. This will contain details of the submission.
169
169
  #
170
170
  # @param description [String, nil] The description of the Check Deposit, for display purposes only.
@@ -646,20 +646,20 @@ module Increase
646
646
  class DepositSubmission < Increase::Internal::Type::BaseModel
647
647
  # @!attribute back_file_id
648
648
  # The ID for the File containing the check back image that was submitted to the
649
- # Check21 network.
649
+ # Check 21 network.
650
650
  #
651
651
  # @return [String]
652
652
  required :back_file_id, String
653
653
 
654
654
  # @!attribute front_file_id
655
655
  # The ID for the File containing the check front image that was submitted to the
656
- # Check21 network.
656
+ # Check 21 network.
657
657
  #
658
658
  # @return [String]
659
659
  required :front_file_id, String
660
660
 
661
661
  # @!attribute submitted_at
662
- # When the check deposit was submitted to the Check21 network for processing.
662
+ # When the check deposit was submitted to the Check 21 network for processing.
663
663
  # During business days, this happens within a few hours of the check being
664
664
  # accepted by Increase.
665
665
  #
@@ -667,19 +667,19 @@ module Increase
667
667
  required :submitted_at, Time
668
668
 
669
669
  # @!method initialize(back_file_id:, front_file_id:, submitted_at:)
670
- # After the check is parsed, it is submitted to the Check21 network for
670
+ # After the check is parsed, it is submitted to the Check 21 network for
671
671
  # processing. This will contain details of the submission.
672
672
  #
673
673
  # @param back_file_id [String]
674
674
  # The ID for the File containing the check back image that was submitted to the
675
- # Check21 network.
675
+ # Check 21 network.
676
676
  #
677
677
  # @param front_file_id [String]
678
678
  # The ID for the File containing the check front image that was submitted to the
679
- # Check21 network.
679
+ # Check 21 network.
680
680
  #
681
681
  # @param submitted_at [Time]
682
- # When the check deposit was submitted to the Check21 network for processing.
682
+ # When the check deposit was submitted to the Check 21 network for processing.
683
683
  # During business days, this happens within a few hours of the check being
684
684
  # accepted by Increase.
685
685
  end
@@ -170,7 +170,7 @@ module Increase
170
170
  # If set, the check will be valid on or before this date. After this date, the
171
171
  # check transfer will be automatically stopped and deposits will not be accepted.
172
172
  # For checks printed by Increase, this date is included on the check as its
173
- # expiry.
173
+ # expiration.
174
174
  #
175
175
  # @return [Date, nil]
176
176
  required :valid_until_date, Date, nil?: true
@@ -266,7 +266,7 @@ module Increase
266
266
  # If set, the check will be valid on or before this date. After this date, the
267
267
  # check transfer will be automatically stopped and deposits will not be accepted.
268
268
  # For checks printed by Increase, this date is included on the check as its
269
- # expiry.
269
+ # expiration.
270
270
 
271
271
  # @see Increase::Models::CheckTransfer#approval
272
272
  class Approval < Increase::Internal::Type::BaseModel
@@ -73,7 +73,7 @@ module Increase
73
73
  # If provided, the check will be valid on or before this date. After this date,
74
74
  # the check transfer will be automatically stopped and deposits will not be
75
75
  # accepted. For checks printed by Increase, this date is included on the check as
76
- # its expiry.
76
+ # its expiration.
77
77
  #
78
78
  # @return [Date, nil]
79
79
  optional :valid_until_date, Date
@@ -116,7 +116,7 @@ module Increase
116
116
  # If provided, the check will be valid on or before this date. After this date,
117
117
  # the check transfer will be automatically stopped and deposits will not be
118
118
  # accepted. For checks printed by Increase, this date is included on the check as
119
- # its expiry.
119
+ # its expiration.
120
120
  #
121
121
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
122
122
 
@@ -195,7 +195,9 @@ module Increase
195
195
  optional :check_voucher_image_file_id, String
196
196
 
197
197
  # @!attribute note
198
- # The descriptor that will be printed on the letter included with the check.
198
+ # A few paragraphs of text printed on the letter included with the check. It can
199
+ # contain at most 22 lines. Paragraphs will wrap at about 120 characters, but
200
+ # depending on your exact message, it might be slightly more or slightly less.
199
201
  #
200
202
  # @return [String, nil]
201
203
  optional :note, String
@@ -264,7 +266,10 @@ module Increase
264
266
  # `purpose: check_voucher_image`. For details on pricing and restrictions, see
265
267
  # https://increase.com/documentation/originating-checks#printing-checks .
266
268
  #
267
- # @param note [String] The descriptor that will be printed on the letter included with the check.
269
+ # @param note [String]
270
+ # A few paragraphs of text printed on the letter included with the check. It can
271
+ # contain at most 22 lines. Paragraphs will wrap at about 120 characters, but
272
+ # depending on your exact message, it might be slightly more or slightly less.
268
273
  #
269
274
  # @param physical_check_batch_id [String]
270
275
  # The identifier of the Physical Check Batch to mail this check as a part of.