increase 1.347.0 → 1.349.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 (124) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/account_create_params.rb +15 -15
  4. data/lib/increase/models/ach_prenotification_create_params.rb +2 -2
  5. data/lib/increase/models/ach_transfer.rb +2 -2
  6. data/lib/increase/models/ach_transfer_create_params.rb +1 -24
  7. data/lib/increase/models/balance_lookup.rb +49 -1
  8. data/lib/increase/models/beneficial_owner_update_params.rb +9 -1
  9. data/lib/increase/models/card.rb +43 -1
  10. data/lib/increase/models/card_create_params.rb +42 -1
  11. data/lib/increase/models/card_dispute.rb +1 -1
  12. data/lib/increase/models/card_dispute_list_params.rb +1 -1
  13. data/lib/increase/models/card_payment.rb +18 -1
  14. data/lib/increase/models/check_transfer.rb +13 -1
  15. data/lib/increase/models/check_transfer_create_params.rb +25 -13
  16. data/lib/increase/models/entity.rb +315 -5
  17. data/lib/increase/models/entity_update_params.rb +754 -1
  18. data/lib/increase/models/event.rb +12 -0
  19. data/lib/increase/models/event_list_params.rb +12 -0
  20. data/lib/increase/models/event_subscription.rb +12 -0
  21. data/lib/increase/models/event_subscription_create_params.rb +12 -0
  22. data/lib/increase/models/file.rb +7 -6
  23. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  24. data/lib/increase/models/inbound_check_deposit.rb +5 -2
  25. data/lib/increase/models/inbound_fednow_transfer.rb +18 -1
  26. data/lib/increase/models/pending_transaction.rb +25 -8
  27. data/lib/increase/models/pending_transaction_list_params.rb +1 -1
  28. data/lib/increase/models/physical_card_create_params.rb +6 -3
  29. data/lib/increase/models/real_time_decision.rb +18 -1
  30. data/lib/increase/models/real_time_payments_transfer.rb +30 -19
  31. data/lib/increase/models/real_time_payments_transfer_create_params.rb +12 -1
  32. data/lib/increase/models/simulations/card_dispute_action_params.rb +30 -1
  33. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -0
  34. data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +8 -11
  35. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +18 -18
  36. data/lib/increase/models/transaction.rb +5 -2
  37. data/lib/increase/models/unwrap_webhook_event.rb +12 -0
  38. data/lib/increase/models/wire_transfer_create_params.rb +100 -42
  39. data/lib/increase/resources/ach_prenotifications.rb +1 -1
  40. data/lib/increase/resources/ach_transfers.rb +1 -4
  41. data/lib/increase/resources/beneficial_owners.rb +3 -1
  42. data/lib/increase/resources/cards.rb +5 -1
  43. data/lib/increase/resources/physical_cards.rb +2 -1
  44. data/lib/increase/resources/real_time_payments_transfers.rb +5 -1
  45. data/lib/increase/resources/simulations/inbound_check_deposits.rb +4 -1
  46. data/lib/increase/version.rb +1 -1
  47. data/rbi/increase/models/account_create_params.rbi +37 -21
  48. data/rbi/increase/models/ach_prenotification_create_params.rbi +2 -2
  49. data/rbi/increase/models/ach_transfer.rbi +2 -2
  50. data/rbi/increase/models/ach_transfer_create_params.rbi +0 -59
  51. data/rbi/increase/models/balance_lookup.rbi +48 -0
  52. data/rbi/increase/models/beneficial_owner_update_params.rbi +11 -0
  53. data/rbi/increase/models/card.rbi +63 -0
  54. data/rbi/increase/models/card_create_params.rbi +65 -0
  55. data/rbi/increase/models/card_dispute.rbi +1 -1
  56. data/rbi/increase/models/card_dispute_list_params.rbi +1 -1
  57. data/rbi/increase/models/card_payment.rbi +16 -0
  58. data/rbi/increase/models/check_transfer.rbi +15 -0
  59. data/rbi/increase/models/check_transfer_create_params.rbi +26 -12
  60. data/rbi/increase/models/entity.rbi +552 -3
  61. data/rbi/increase/models/entity_update_params.rbi +1326 -3
  62. data/rbi/increase/models/event.rbi +28 -0
  63. data/rbi/increase/models/event_list_params.rbi +28 -0
  64. data/rbi/increase/models/event_subscription.rbi +28 -0
  65. data/rbi/increase/models/event_subscription_create_params.rbi +28 -0
  66. data/rbi/increase/models/file.rbi +7 -6
  67. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  68. data/rbi/increase/models/inbound_check_deposit.rbi +4 -2
  69. data/rbi/increase/models/inbound_fednow_transfer.rbi +16 -0
  70. data/rbi/increase/models/pending_transaction.rbi +23 -7
  71. data/rbi/increase/models/pending_transaction_list_params.rbi +1 -1
  72. data/rbi/increase/models/physical_card_create_params.rbi +6 -3
  73. data/rbi/increase/models/real_time_decision.rbi +16 -0
  74. data/rbi/increase/models/real_time_payments_transfer.rbi +29 -18
  75. data/rbi/increase/models/real_time_payments_transfer_create_params.rbi +15 -0
  76. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +60 -0
  77. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +7 -0
  78. data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi +8 -23
  79. data/rbi/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +18 -18
  80. data/rbi/increase/models/transaction.rbi +4 -2
  81. data/rbi/increase/models/unwrap_webhook_event.rbi +28 -0
  82. data/rbi/increase/models/wire_transfer_create_params.rbi +146 -62
  83. data/rbi/increase/resources/ach_prenotifications.rbi +1 -1
  84. data/rbi/increase/resources/ach_transfers.rbi +0 -4
  85. data/rbi/increase/resources/beneficial_owners.rbi +3 -0
  86. data/rbi/increase/resources/cards.rbi +4 -0
  87. data/rbi/increase/resources/physical_cards.rbi +2 -1
  88. data/rbi/increase/resources/real_time_payments_transfers.rbi +4 -0
  89. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +4 -1
  90. data/sig/increase/models/account_create_params.rbs +20 -12
  91. data/sig/increase/models/ach_transfer_create_params.rbs +1 -24
  92. data/sig/increase/models/balance_lookup.rbs +30 -0
  93. data/sig/increase/models/beneficial_owner_update_params.rbs +7 -0
  94. data/sig/increase/models/card.rbs +19 -0
  95. data/sig/increase/models/card_create_params.rbs +25 -0
  96. data/sig/increase/models/card_dispute.rbs +1 -1
  97. data/sig/increase/models/card_dispute_list_params.rbs +1 -1
  98. data/sig/increase/models/card_payment.rbs +5 -0
  99. data/sig/increase/models/check_transfer.rbs +9 -0
  100. data/sig/increase/models/check_transfer_create_params.rbs +7 -0
  101. data/sig/increase/models/entity.rbs +248 -5
  102. data/sig/increase/models/entity_update_params.rbs +585 -3
  103. data/sig/increase/models/event.rbs +16 -0
  104. data/sig/increase/models/event_list_params.rbs +16 -0
  105. data/sig/increase/models/event_subscription.rbs +16 -0
  106. data/sig/increase/models/event_subscription_create_params.rbs +16 -0
  107. data/sig/increase/models/inbound_ach_transfer.rbs +2 -2
  108. data/sig/increase/models/inbound_fednow_transfer.rbs +10 -0
  109. data/sig/increase/models/pending_transaction.rbs +6 -1
  110. data/sig/increase/models/pending_transaction_list_params.rbs +1 -1
  111. data/sig/increase/models/real_time_decision.rbs +5 -0
  112. data/sig/increase/models/real_time_payments_transfer.rbs +23 -18
  113. data/sig/increase/models/real_time_payments_transfer_create_params.rbs +7 -0
  114. data/sig/increase/models/simulations/card_dispute_action_params.rbs +23 -0
  115. data/sig/increase/models/simulations/entity_update_validation_params.rbs +4 -0
  116. data/sig/increase/models/simulations/inbound_check_deposit_adjustment_params.rbs +1 -15
  117. data/sig/increase/models/simulations/real_time_payments_transfer_complete_params.rbs +18 -18
  118. data/sig/increase/models/unwrap_webhook_event.rbs +16 -0
  119. data/sig/increase/models/wire_transfer_create_params.rbs +78 -32
  120. data/sig/increase/resources/ach_transfers.rbs +0 -1
  121. data/sig/increase/resources/beneficial_owners.rbs +1 -0
  122. data/sig/increase/resources/cards.rbs +1 -0
  123. data/sig/increase/resources/real_time_payments_transfers.rbs +1 -0
  124. metadata +2 -2
@@ -92,6 +92,13 @@ module Increase
92
92
  optional :receive_merchant_prearbitration,
93
93
  -> { Increase::Simulations::CardDisputeActionParams::Visa::ReceiveMerchantPrearbitration }
94
94
 
95
+ # @!attribute reject
96
+ # The parameters for rejecting the dispute. Required if and only if `action` is
97
+ # `reject`.
98
+ #
99
+ # @return [Increase::Models::Simulations::CardDisputeActionParams::Visa::Reject, nil]
100
+ optional :reject, -> { Increase::Simulations::CardDisputeActionParams::Visa::Reject }
101
+
95
102
  # @!attribute represent
96
103
  # The parameters for re-presenting the dispute. Required if and only if `action`
97
104
  # is `represent`.
@@ -139,7 +146,7 @@ module Increase
139
146
  optional :time_out_user_prearbitration,
140
147
  -> { Increase::Simulations::CardDisputeActionParams::Visa::TimeOutUserPrearbitration }
141
148
 
142
- # @!method initialize(action:, accept_chargeback: nil, accept_user_submission: nil, decline_user_prearbitration: nil, receive_merchant_prearbitration: nil, represent: nil, request_further_information: nil, time_out_chargeback: nil, time_out_merchant_prearbitration: nil, time_out_representment: nil, time_out_user_prearbitration: nil)
149
+ # @!method initialize(action:, accept_chargeback: nil, accept_user_submission: nil, decline_user_prearbitration: nil, receive_merchant_prearbitration: nil, reject: nil, represent: nil, request_further_information: nil, time_out_chargeback: nil, time_out_merchant_prearbitration: nil, time_out_representment: nil, time_out_user_prearbitration: nil)
143
150
  # The Visa-specific parameters for the taking action on the dispute. Required if
144
151
  # and only if `network` is `visa`.
145
152
  #
@@ -163,6 +170,10 @@ module Increase
163
170
  # The parameters for receiving the prearbitration. Required if and only if
164
171
  # `action` is `receive_merchant_prearbitration`.
165
172
  #
173
+ # @param reject [Increase::Models::Simulations::CardDisputeActionParams::Visa::Reject]
174
+ # The parameters for rejecting the dispute. Required if and only if `action` is
175
+ # `reject`.
176
+ #
166
177
  # @param represent [Increase::Models::Simulations::CardDisputeActionParams::Visa::Represent]
167
178
  # The parameters for re-presenting the dispute. Required if and only if `action`
168
179
  # is `represent`.
@@ -206,6 +217,9 @@ module Increase
206
217
  # Simulate the merchant issuing pre-arbitration. This will move the dispute to a `user_submission_required` state.
207
218
  RECEIVE_MERCHANT_PREARBITRATION = :receive_merchant_prearbitration
208
219
 
220
+ # Simulate the dispute being rejected before it is submitted to the network. This will move the dispute to a `rejected` state.
221
+ REJECT = :reject
222
+
209
223
  # Simulate the merchant re-presenting the dispute. This will move the dispute to a `user_submission_required` state.
210
224
  REPRESENT = :represent
211
225
 
@@ -256,6 +270,21 @@ module Increase
256
270
  # `action` is `receive_merchant_prearbitration`.
257
271
  end
258
272
 
273
+ # @see Increase::Models::Simulations::CardDisputeActionParams::Visa#reject
274
+ class Reject < Increase::Internal::Type::BaseModel
275
+ # @!attribute explanation
276
+ # The explanation for rejecting the dispute.
277
+ #
278
+ # @return [String]
279
+ required :explanation, String
280
+
281
+ # @!method initialize(explanation:)
282
+ # The parameters for rejecting the dispute. Required if and only if `action` is
283
+ # `reject`.
284
+ #
285
+ # @param explanation [String] The explanation for rejecting the dispute.
286
+ end
287
+
259
288
  # @see Increase::Models::Simulations::CardDisputeActionParams::Visa#represent
260
289
  class Represent < Increase::Internal::Type::BaseModel
261
290
  # @!method initialize
@@ -54,6 +54,9 @@ module Increase
54
54
  # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
55
55
  ENTITY_ADDRESS = :entity_address
56
56
 
57
+ # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity.natural_person.identification).
58
+ ENTITY_IDENTITY = :entity_identity
59
+
57
60
  # A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
58
61
  BENEFICIAL_OWNER_IDENTITY = :beneficial_owner_identity
59
62
 
@@ -15,7 +15,10 @@ module Increase
15
15
  required :inbound_check_deposit_id, String
16
16
 
17
17
  # @!attribute amount
18
- # The adjustment amount in cents. Defaults to the amount of the Inbound Check
18
+ # The adjustment amount in cents. A positive amount means that the funds are being
19
+ # returned to you by the other bank and is a credit to your account, as happens
20
+ # for a `wrong_payee_credit`. A negative amount is a debit to your account, as
21
+ # happens for a `late_return`. Defaults to the amount of the Inbound Check
19
22
  # Deposit.
20
23
  #
21
24
  # @return [Integer, nil]
@@ -31,7 +34,10 @@ module Increase
31
34
  # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
32
35
  #
33
36
  # @param amount [Integer]
34
- # The adjustment amount in cents. Defaults to the amount of the Inbound Check
37
+ # The adjustment amount in cents. A positive amount means that the funds are being
38
+ # returned to you by the other bank and is a credit to your account, as happens
39
+ # for a `wrong_payee_credit`. A negative amount is a debit to your account, as
40
+ # happens for a `late_return`. Defaults to the amount of the Inbound Check
35
41
  # Deposit.
36
42
  #
37
43
  # @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason]
@@ -49,15 +55,6 @@ module Increase
49
55
  # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
50
56
  WRONG_PAYEE_CREDIT = :wrong_payee_credit
51
57
 
52
- # The check was deposited with a different amount than what was written on the check.
53
- ADJUSTED_AMOUNT = :adjusted_amount
54
-
55
- # The recipient was not able to process the check. This usually happens for e.g., low quality images.
56
- NON_CONFORMING_ITEM = :non_conforming_item
57
-
58
- # The check has already been deposited elsewhere and so this is a duplicate.
59
- PAID = :paid
60
-
61
58
  # @!method self.values
62
59
  # @return [Array<Symbol>]
63
60
  end
@@ -49,61 +49,61 @@ module Increase
49
49
  module RejectReasonCode
50
50
  extend Increase::Internal::Type::Enum
51
51
 
52
- # The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`.
52
+ # The destination account is closed. Corresponds to the Real-Time Payments reason code "AC04".
53
53
  ACCOUNT_CLOSED = :account_closed
54
54
 
55
- # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`.
55
+ # The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code "AC06".
56
56
  ACCOUNT_BLOCKED = :account_blocked
57
57
 
58
- # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`.
58
+ # The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code "AC14".
59
59
  INVALID_CREDITOR_ACCOUNT_TYPE = :invalid_creditor_account_type
60
60
 
61
- # The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`.
61
+ # The destination account does not exist. Corresponds to the Real-Time Payments reason code "AC03".
62
62
  INVALID_CREDITOR_ACCOUNT_NUMBER = :invalid_creditor_account_number
63
63
 
64
- # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`.
64
+ # The destination routing number is invalid. Corresponds to the Real-Time Payments reason code "RC04".
65
65
  INVALID_CREDITOR_FINANCIAL_INSTITUTION_IDENTIFIER = :invalid_creditor_financial_institution_identifier
66
66
 
67
- # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`.
67
+ # The destination account holder is deceased. Corresponds to the Real-Time Payments reason code "MD07".
68
68
  END_CUSTOMER_DECEASED = :end_customer_deceased
69
69
 
70
70
  # The reason is provided as narrative information in the additional information field.
71
71
  NARRATIVE = :narrative
72
72
 
73
- # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`.
73
+ # Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code "AG01".
74
74
  TRANSACTION_FORBIDDEN = :transaction_forbidden
75
75
 
76
- # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`.
76
+ # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code "AG03".
77
77
  TRANSACTION_TYPE_NOT_SUPPORTED = :transaction_type_not_supported
78
78
 
79
- # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`.
79
+ # The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code "AM09".
80
80
  UNEXPECTED_AMOUNT = :unexpected_amount
81
81
 
82
- # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`.
82
+ # The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code "AM14".
83
83
  AMOUNT_EXCEEDS_BANK_LIMITS = :amount_exceeds_bank_limits
84
84
 
85
- # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`.
85
+ # The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code "BE04".
86
86
  INVALID_CREDITOR_ADDRESS = :invalid_creditor_address
87
87
 
88
- # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`.
88
+ # The specified creditor is unknown. Corresponds to the Real-Time Payments reason code "BE06".
89
89
  UNKNOWN_END_CUSTOMER = :unknown_end_customer
90
90
 
91
- # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`.
91
+ # The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code "BE07".
92
92
  INVALID_DEBTOR_ADDRESS = :invalid_debtor_address
93
93
 
94
- # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`.
94
+ # There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code "DS24".
95
95
  TIMEOUT = :timeout
96
96
 
97
- # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`.
97
+ # Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code "NOAT".
98
98
  UNSUPPORTED_MESSAGE_FOR_RECIPIENT = :unsupported_message_for_recipient
99
99
 
100
- # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`.
100
+ # The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code "9912".
101
101
  RECIPIENT_CONNECTION_NOT_AVAILABLE = :recipient_connection_not_available
102
102
 
103
- # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`.
103
+ # Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code "9948".
104
104
  REAL_TIME_PAYMENTS_SUSPENDED = :real_time_payments_suspended
105
105
 
106
- # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`.
106
+ # The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code "9910".
107
107
  INSTRUCTED_AGENT_SIGNED_OFF = :instructed_agent_signed_off
108
108
 
109
109
  # The transfer was rejected due to an internal Increase issue. We have been notified.
@@ -7231,7 +7231,8 @@ module Increase
7231
7231
  required :adjusted_transaction_id, String
7232
7232
 
7233
7233
  # @!attribute amount
7234
- # The amount of the check adjustment.
7234
+ # The amount of the check adjustment in USD cents. A positive amount is a credit
7235
+ # to your account and a negative amount is a debit.
7235
7236
  #
7236
7237
  # @return [Integer]
7237
7238
  required :amount, Integer
@@ -7250,7 +7251,9 @@ module Increase
7250
7251
  #
7251
7252
  # @param adjusted_transaction_id [String] The ID of the transaction that was adjusted.
7252
7253
  #
7253
- # @param amount [Integer] The amount of the check adjustment.
7254
+ # @param amount [Integer]
7255
+ # The amount of the check adjustment in USD cents. A positive amount is a credit
7256
+ # to your account and a negative amount is a debit.
7254
7257
  #
7255
7258
  # @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason]
7256
7259
  # The reason for the adjustment.
@@ -303,6 +303,9 @@ module Increase
303
303
  # Occurs whenever a Loan Distribution is created.
304
304
  LOAN_DISTRIBUTION_CREATED = :"loan_distribution.created"
305
305
 
306
+ # Occurs whenever a Loan Obligation is created.
307
+ LOAN_OBLIGATION_CREATED = :"loan_obligation.created"
308
+
306
309
  # Occurs whenever a Loan Offer is created.
307
310
  LOAN_OFFER_CREATED = :"loan_offer.created"
308
311
 
@@ -318,6 +321,12 @@ module Increase
318
321
  # Occurs whenever a Lockbox is updated.
319
322
  LOCKBOX_UPDATED = :"lockbox.updated"
320
323
 
324
+ # Occurs whenever a Lockbox Address is created.
325
+ LOCKBOX_ADDRESS_CREATED = :"lockbox_address.created"
326
+
327
+ # Occurs whenever a Lockbox Address is updated.
328
+ LOCKBOX_ADDRESS_UPDATED = :"lockbox_address.updated"
329
+
321
330
  # Occurs whenever an OAuth Connection is created.
322
331
  OAUTH_CONNECTION_CREATED = :"oauth_connection.created"
323
332
 
@@ -360,6 +369,9 @@ module Increase
360
369
  # Occurs whenever a Physical Check is updated.
361
370
  PHYSICAL_CHECK_UPDATED = :"physical_check.updated"
362
371
 
372
+ # Occurs whenever a Plaid Processor Token is created.
373
+ PLAID_PROCESSOR_TOKEN_CREATED = :"plaid_processor_token.created"
374
+
363
375
  # Occurs whenever a Checkbook is created.
364
376
  CHECKBOOK_CREATED = :"checkbook.created"
365
377
 
@@ -139,46 +139,75 @@ module Increase
139
139
 
140
140
  # @see Increase::Models::WireTransferCreateParams::Creditor#address
141
141
  class Address < Increase::Internal::Type::BaseModel
142
- # @!attribute unstructured
143
- # Unstructured address lines.
142
+ # @!attribute structured
143
+ # Structured address components. City and country are required.
144
144
  #
145
- # @return [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured, nil]
146
- optional :unstructured, -> { Increase::WireTransferCreateParams::Creditor::Address::Unstructured }
145
+ # @return [Increase::Models::WireTransferCreateParams::Creditor::Address::Structured, nil]
146
+ optional :structured, -> { Increase::WireTransferCreateParams::Creditor::Address::Structured }
147
147
 
148
- # @!method initialize(unstructured: nil)
148
+ # @!method initialize(structured: nil)
149
149
  # The person or business's address.
150
150
  #
151
- # @param unstructured [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured]
152
- # Unstructured address lines.
151
+ # @param structured [Increase::Models::WireTransferCreateParams::Creditor::Address::Structured]
152
+ # Structured address components. City and country are required.
153
153
 
154
- # @see Increase::Models::WireTransferCreateParams::Creditor::Address#unstructured
155
- class Unstructured < Increase::Internal::Type::BaseModel
156
- # @!attribute line1
157
- # The address line 1.
154
+ # @see Increase::Models::WireTransferCreateParams::Creditor::Address#structured
155
+ class Structured < Increase::Internal::Type::BaseModel
156
+ # @!attribute city
157
+ # The city, district, town, or village of the address.
158
+ #
159
+ # @return [String]
160
+ required :city, String
161
+
162
+ # @!attribute country
163
+ # The two-letter
164
+ # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
165
+ # the country of the address.
158
166
  #
159
167
  # @return [String]
160
- required :line1, String
168
+ required :country, String
169
+
170
+ # @!attribute line1
171
+ # The first line of the address.
172
+ #
173
+ # @return [String, nil]
174
+ optional :line1, String
161
175
 
162
176
  # @!attribute line2
163
- # The address line 2.
177
+ # The second line of the address.
164
178
  #
165
179
  # @return [String, nil]
166
180
  optional :line2, String
167
181
 
168
- # @!attribute line3
169
- # The address line 3.
182
+ # @!attribute postal_code
183
+ # The postal code of the address.
184
+ #
185
+ # @return [String, nil]
186
+ optional :postal_code, String
187
+
188
+ # @!attribute state
189
+ # The address state.
170
190
  #
171
191
  # @return [String, nil]
172
- optional :line3, String
192
+ optional :state, String
173
193
 
174
- # @!method initialize(line1:, line2: nil, line3: nil)
175
- # Unstructured address lines.
194
+ # @!method initialize(city:, country:, line1: nil, line2: nil, postal_code: nil, state: nil)
195
+ # Structured address components. City and country are required.
196
+ #
197
+ # @param city [String] The city, district, town, or village of the address.
198
+ #
199
+ # @param country [String]
200
+ # The two-letter
201
+ # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
202
+ # the country of the address.
203
+ #
204
+ # @param line1 [String] The first line of the address.
176
205
  #
177
- # @param line1 [String] The address line 1.
206
+ # @param line2 [String] The second line of the address.
178
207
  #
179
- # @param line2 [String] The address line 2.
208
+ # @param postal_code [String] The postal code of the address.
180
209
  #
181
- # @param line3 [String] The address line 3.
210
+ # @param state [String] The address state.
182
211
  end
183
212
  end
184
213
  end
@@ -312,46 +341,75 @@ module Increase
312
341
 
313
342
  # @see Increase::Models::WireTransferCreateParams::Debtor#address
314
343
  class Address < Increase::Internal::Type::BaseModel
315
- # @!attribute unstructured
316
- # Unstructured address lines.
344
+ # @!attribute structured
345
+ # Structured address components. City and country are required.
317
346
  #
318
- # @return [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured, nil]
319
- optional :unstructured, -> { Increase::WireTransferCreateParams::Debtor::Address::Unstructured }
347
+ # @return [Increase::Models::WireTransferCreateParams::Debtor::Address::Structured, nil]
348
+ optional :structured, -> { Increase::WireTransferCreateParams::Debtor::Address::Structured }
320
349
 
321
- # @!method initialize(unstructured: nil)
350
+ # @!method initialize(structured: nil)
322
351
  # The person or business's address.
323
352
  #
324
- # @param unstructured [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured]
325
- # Unstructured address lines.
353
+ # @param structured [Increase::Models::WireTransferCreateParams::Debtor::Address::Structured]
354
+ # Structured address components. City and country are required.
326
355
 
327
- # @see Increase::Models::WireTransferCreateParams::Debtor::Address#unstructured
328
- class Unstructured < Increase::Internal::Type::BaseModel
329
- # @!attribute line1
330
- # The address line 1.
356
+ # @see Increase::Models::WireTransferCreateParams::Debtor::Address#structured
357
+ class Structured < Increase::Internal::Type::BaseModel
358
+ # @!attribute city
359
+ # The city, district, town, or village of the address.
360
+ #
361
+ # @return [String]
362
+ required :city, String
363
+
364
+ # @!attribute country
365
+ # The two-letter
366
+ # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
367
+ # the country of the address.
331
368
  #
332
369
  # @return [String]
333
- required :line1, String
370
+ required :country, String
371
+
372
+ # @!attribute line1
373
+ # The first line of the address.
374
+ #
375
+ # @return [String, nil]
376
+ optional :line1, String
334
377
 
335
378
  # @!attribute line2
336
- # The address line 2.
379
+ # The second line of the address.
337
380
  #
338
381
  # @return [String, nil]
339
382
  optional :line2, String
340
383
 
341
- # @!attribute line3
342
- # The address line 3.
384
+ # @!attribute postal_code
385
+ # The postal code of the address.
386
+ #
387
+ # @return [String, nil]
388
+ optional :postal_code, String
389
+
390
+ # @!attribute state
391
+ # The address state.
343
392
  #
344
393
  # @return [String, nil]
345
- optional :line3, String
394
+ optional :state, String
346
395
 
347
- # @!method initialize(line1:, line2: nil, line3: nil)
348
- # Unstructured address lines.
396
+ # @!method initialize(city:, country:, line1: nil, line2: nil, postal_code: nil, state: nil)
397
+ # Structured address components. City and country are required.
398
+ #
399
+ # @param city [String] The city, district, town, or village of the address.
400
+ #
401
+ # @param country [String]
402
+ # The two-letter
403
+ # [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
404
+ # the country of the address.
405
+ #
406
+ # @param line1 [String] The first line of the address.
349
407
  #
350
- # @param line1 [String] The address line 1.
408
+ # @param line2 [String] The second line of the address.
351
409
  #
352
- # @param line2 [String] The address line 2.
410
+ # @param postal_code [String] The postal code of the address.
353
411
  #
354
- # @param line3 [String] The address line 3.
412
+ # @param state [String] The address state.
355
413
  end
356
414
  end
357
415
  end
@@ -37,7 +37,7 @@ module Increase
37
37
  # @param individual_id [String] Your identifier for the recipient.
38
38
  #
39
39
  # @param individual_name [String]
40
- # The name of therecipient. This value is informational and not verified by the
40
+ # The name of the recipient. This value is informational and not verified by the
41
41
  # recipient's bank.
42
42
  #
43
43
  # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]
@@ -5,7 +5,7 @@ module Increase
5
5
  class ACHTransfers
6
6
  # Create an ACH Transfer
7
7
  #
8
- # @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, transaction_timing: nil, request_options: {})
8
+ # @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
9
9
  #
10
10
  # @param account_id [String] The Increase identifier for the account that will send the transfer.
11
11
  #
@@ -94,9 +94,6 @@ module Increase
94
94
  # to use for the transfer. If not provided, the default is
95
95
  # `corporate_credit_or_debit`.
96
96
  #
97
- # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming]
98
- # The timing of the transaction.
99
- #
100
97
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
101
98
  #
102
99
  # @return [Increase::Models::ACHTransfer]
@@ -59,7 +59,7 @@ module Increase
59
59
 
60
60
  # Update a Beneficial Owner
61
61
  #
62
- # @overload update(entity_beneficial_owner_id, address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil, prongs: nil, request_options: {})
62
+ # @overload update(entity_beneficial_owner_id, address: nil, confirmed_no_us_tax_id: nil, date_of_birth: nil, identification: nil, name: nil, prongs: nil, request_options: {})
63
63
  #
64
64
  # @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
65
65
  #
@@ -73,6 +73,8 @@ module Increase
73
73
  # tax id (either a Social Security Number or Individual Taxpayer Identification
74
74
  # Number).
75
75
  #
76
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
77
+ #
76
78
  # @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
77
79
  # A means of verifying the person's identity.
78
80
  #
@@ -5,7 +5,7 @@ module Increase
5
5
  class Cards
6
6
  # Create a Card
7
7
  #
8
- # @overload create(account_id:, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
8
+ # @overload create(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
9
9
  #
10
10
  # @param account_id [String] The Account the card should belong to.
11
11
  #
@@ -14,6 +14,10 @@ module Increase
14
14
  #
15
15
  # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
16
16
  #
17
+ # @param cardholder_name [Increase::Models::CardCreateParams::CardholderName]
18
+ # The name of the cardholder. Used to respond to Account Name Inquiry requests
19
+ # from acquirers in Card Validations.
20
+ #
17
21
  # @param description [String] The description you choose to give the card.
18
22
  #
19
23
  # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
@@ -10,7 +10,8 @@ module Increase
10
10
  # @param card_id [String] The underlying card representing this physical card.
11
11
  #
12
12
  # @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
13
- # Details about the cardholder, as it will appear on the physical card.
13
+ # Details about the cardholder, as it will appear on the physical card. The
14
+ # combined first name and last name cannot exceed 25 characters.
14
15
  #
15
16
  # @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
16
17
  # The details used to ship this physical card.
@@ -5,7 +5,7 @@ module Increase
5
5
  class RealTimePaymentsTransfers
6
6
  # Create a Real-Time Payments Transfer
7
7
  #
8
- # @overload create(amount:, creditor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, debtor_name: nil, external_account_id: nil, require_approval: nil, routing_number: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {})
8
+ # @overload create(amount:, creditor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, debtor_name: nil, external_account_id: nil, inbound_real_time_payments_request_for_payment_id: nil, require_approval: nil, routing_number: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {})
9
9
  #
10
10
  # @param amount [Integer]
11
11
  # The transfer amount in USD cents. For Real-Time Payments transfers, must be
@@ -29,6 +29,10 @@ module Increase
29
29
  # The ID of an External Account to initiate a transfer to. If this parameter is
30
30
  # provided, `account_number` and `routing_number` must be absent.
31
31
  #
32
+ # @param inbound_real_time_payments_request_for_payment_id [String]
33
+ # The ID of an Inbound Real-Time Payments Request for Payment in response to which
34
+ # this transfer is being sent.
35
+ #
32
36
  # @param require_approval [Boolean]
33
37
  # Whether the transfer requires explicit approval via the dashboard or API.
34
38
  #
@@ -50,7 +50,10 @@ module Increase
50
50
  # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
51
51
  #
52
52
  # @param amount [Integer]
53
- # The adjustment amount in cents. Defaults to the amount of the Inbound Check
53
+ # The adjustment amount in cents. A positive amount means that the funds are being
54
+ # returned to you by the other bank and is a credit to your account, as happens
55
+ # for a `wrong_payee_credit`. A negative amount is a debit to your account, as
56
+ # happens for a `late_return`. Defaults to the amount of the Inbound Check
54
57
  # Deposit.
55
58
  #
56
59
  # @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.347.0"
4
+ VERSION = "1.349.0"
5
5
  end