increase 1.347.0 → 1.348.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 (102) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/models/ach_prenotification_create_params.rb +2 -2
  4. data/lib/increase/models/ach_transfer.rb +2 -2
  5. data/lib/increase/models/ach_transfer_create_params.rb +1 -24
  6. data/lib/increase/models/balance_lookup.rb +49 -1
  7. data/lib/increase/models/beneficial_owner_update_params.rb +9 -1
  8. data/lib/increase/models/card.rb +43 -1
  9. data/lib/increase/models/card_create_params.rb +42 -1
  10. data/lib/increase/models/card_dispute.rb +1 -1
  11. data/lib/increase/models/card_dispute_list_params.rb +1 -1
  12. data/lib/increase/models/card_payment.rb +18 -1
  13. data/lib/increase/models/check_transfer.rb +13 -1
  14. data/lib/increase/models/check_transfer_create_params.rb +25 -13
  15. data/lib/increase/models/entity.rb +22 -4
  16. data/lib/increase/models/entity_update_params.rb +754 -1
  17. data/lib/increase/models/event.rb +9 -0
  18. data/lib/increase/models/event_list_params.rb +9 -0
  19. data/lib/increase/models/event_subscription.rb +9 -0
  20. data/lib/increase/models/event_subscription_create_params.rb +9 -0
  21. data/lib/increase/models/file.rb +7 -6
  22. data/lib/increase/models/inbound_ach_transfer.rb +6 -6
  23. data/lib/increase/models/pending_transaction.rb +18 -1
  24. data/lib/increase/models/real_time_decision.rb +18 -1
  25. data/lib/increase/models/real_time_payments_transfer.rb +30 -19
  26. data/lib/increase/models/real_time_payments_transfer_create_params.rb +12 -1
  27. data/lib/increase/models/simulations/card_dispute_action_params.rb +30 -1
  28. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -0
  29. data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +18 -18
  30. data/lib/increase/models/unwrap_webhook_event.rb +9 -0
  31. data/lib/increase/models/wire_transfer_create_params.rb +100 -42
  32. data/lib/increase/resources/ach_prenotifications.rb +1 -1
  33. data/lib/increase/resources/ach_transfers.rb +1 -4
  34. data/lib/increase/resources/beneficial_owners.rb +3 -1
  35. data/lib/increase/resources/cards.rb +5 -1
  36. data/lib/increase/resources/real_time_payments_transfers.rb +5 -1
  37. data/lib/increase/version.rb +1 -1
  38. data/rbi/increase/models/ach_prenotification_create_params.rbi +2 -2
  39. data/rbi/increase/models/ach_transfer.rbi +2 -2
  40. data/rbi/increase/models/ach_transfer_create_params.rbi +0 -59
  41. data/rbi/increase/models/balance_lookup.rbi +48 -0
  42. data/rbi/increase/models/beneficial_owner_update_params.rbi +11 -0
  43. data/rbi/increase/models/card.rbi +63 -0
  44. data/rbi/increase/models/card_create_params.rbi +65 -0
  45. data/rbi/increase/models/card_dispute.rbi +1 -1
  46. data/rbi/increase/models/card_dispute_list_params.rbi +1 -1
  47. data/rbi/increase/models/card_payment.rbi +16 -0
  48. data/rbi/increase/models/check_transfer.rbi +15 -0
  49. data/rbi/increase/models/check_transfer_create_params.rbi +26 -12
  50. data/rbi/increase/models/entity.rbi +61 -3
  51. data/rbi/increase/models/entity_update_params.rbi +1326 -3
  52. data/rbi/increase/models/event.rbi +21 -0
  53. data/rbi/increase/models/event_list_params.rbi +21 -0
  54. data/rbi/increase/models/event_subscription.rbi +21 -0
  55. data/rbi/increase/models/event_subscription_create_params.rbi +21 -0
  56. data/rbi/increase/models/file.rbi +7 -6
  57. data/rbi/increase/models/inbound_ach_transfer.rbi +6 -6
  58. data/rbi/increase/models/pending_transaction.rbi +16 -0
  59. data/rbi/increase/models/real_time_decision.rbi +16 -0
  60. data/rbi/increase/models/real_time_payments_transfer.rbi +29 -18
  61. data/rbi/increase/models/real_time_payments_transfer_create_params.rbi +15 -0
  62. data/rbi/increase/models/simulations/card_dispute_action_params.rbi +60 -0
  63. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +7 -0
  64. data/rbi/increase/models/simulations/real_time_payments_transfer_complete_params.rbi +18 -18
  65. data/rbi/increase/models/unwrap_webhook_event.rbi +21 -0
  66. data/rbi/increase/models/wire_transfer_create_params.rbi +146 -62
  67. data/rbi/increase/resources/ach_prenotifications.rbi +1 -1
  68. data/rbi/increase/resources/ach_transfers.rbi +0 -4
  69. data/rbi/increase/resources/beneficial_owners.rbi +3 -0
  70. data/rbi/increase/resources/cards.rbi +4 -0
  71. data/rbi/increase/resources/real_time_payments_transfers.rbi +4 -0
  72. data/sig/increase/models/ach_transfer_create_params.rbs +1 -24
  73. data/sig/increase/models/balance_lookup.rbs +30 -0
  74. data/sig/increase/models/beneficial_owner_update_params.rbs +7 -0
  75. data/sig/increase/models/card.rbs +19 -0
  76. data/sig/increase/models/card_create_params.rbs +25 -0
  77. data/sig/increase/models/card_dispute.rbs +1 -1
  78. data/sig/increase/models/card_dispute_list_params.rbs +1 -1
  79. data/sig/increase/models/card_payment.rbs +5 -0
  80. data/sig/increase/models/check_transfer.rbs +9 -0
  81. data/sig/increase/models/check_transfer_create_params.rbs +7 -0
  82. data/sig/increase/models/entity.rbs +21 -4
  83. data/sig/increase/models/entity_update_params.rbs +585 -3
  84. data/sig/increase/models/event.rbs +12 -0
  85. data/sig/increase/models/event_list_params.rbs +12 -0
  86. data/sig/increase/models/event_subscription.rbs +12 -0
  87. data/sig/increase/models/event_subscription_create_params.rbs +12 -0
  88. data/sig/increase/models/inbound_ach_transfer.rbs +2 -2
  89. data/sig/increase/models/pending_transaction.rbs +5 -0
  90. data/sig/increase/models/real_time_decision.rbs +5 -0
  91. data/sig/increase/models/real_time_payments_transfer.rbs +23 -18
  92. data/sig/increase/models/real_time_payments_transfer_create_params.rbs +7 -0
  93. data/sig/increase/models/simulations/card_dispute_action_params.rbs +23 -0
  94. data/sig/increase/models/simulations/entity_update_validation_params.rbs +4 -0
  95. data/sig/increase/models/simulations/real_time_payments_transfer_complete_params.rbs +18 -18
  96. data/sig/increase/models/unwrap_webhook_event.rbs +12 -0
  97. data/sig/increase/models/wire_transfer_create_params.rbs +78 -32
  98. data/sig/increase/resources/ach_transfers.rbs +0 -1
  99. data/sig/increase/resources/beneficial_owners.rbs +1 -0
  100. data/sig/increase/resources/cards.rbs +1 -0
  101. data/sig/increase/resources/real_time_payments_transfers.rbs +1 -0
  102. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9721f0cea6c29a79e0bc991becf4491dd8aae9516c957e2548f5f047147a9c4a
4
- data.tar.gz: 289a88d3f39ebaa334c5bbd0e7c00a6a407aeb558e3b463ee1e85c4d1e5ba163
3
+ metadata.gz: 4906aa8f308343c378626b6265d93e48bf8af288708b41db066670fa53d7fa8c
4
+ data.tar.gz: eec002779689677251e1de2b783090b1ed44467b1f6382abaf26d02c3b6968ba
5
5
  SHA512:
6
- metadata.gz: dc6f8c4480df3a69f005c76b68732b2f264ba7c431c50b836589f4bb420eb5c9ba927d7e2be71c0c146f473441ff86169b43fbb90852102d16228a08da283a9e
7
- data.tar.gz: d7894b272e43d8e09b438c65f11e3bd6b40f0f227a2b6ab2de04517dadc017efe59c5c45a66424786eb7fb0775a656dc8e1ac94213e99346ccedafc2800aa139
6
+ metadata.gz: 6169cec9a4d096d4c450488c0d7a8162825211274c0dfdeb33bea731b5a5ffd635c3ced4951af088001c71f73c7ce88f4fb34145d0a6f9d54f087cda8a111850
7
+ data.tar.gz: 25f2bd53fb1eb615af2dab37b0a527fc52130bcd80b721a1d01c7a91ea84ae9865f35314a8a3935135448283abfb5acab3074fcb9b4c6b4d3310b8407b607a29
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.347.0"
18
+ gem "increase", "~> 1.348.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -79,7 +79,7 @@ module Increase
79
79
  optional :individual_id, String
80
80
 
81
81
  # @!attribute individual_name
82
- # The name of therecipient. This value is informational and not verified by the
82
+ # The name of the recipient. This value is informational and not verified by the
83
83
  # recipient's bank.
84
84
  #
85
85
  # @return [String, nil]
@@ -127,7 +127,7 @@ module Increase
127
127
  # @param individual_id [String] Your identifier for the recipient.
128
128
  #
129
129
  # @param individual_name [String]
130
- # The name of therecipient. This value is informational and not verified by the
130
+ # The name of the recipient. This value is informational and not verified by the
131
131
  # recipient's bank.
132
132
  #
133
133
  # @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]
@@ -1497,7 +1497,7 @@ module Increase
1497
1497
  class Submission < Increase::Internal::Type::BaseModel
1498
1498
  # @!attribute administrative_returns_expected_by
1499
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
1500
+ # by. This follows the Nacha guidelines for return windows, which are: "In
1501
1501
  # general, return entries must be received by the RDFI’s ACH Operator by its
1502
1502
  # deposit deadline for the return entry to be made available to the ODFI no later
1503
1503
  # than the opening of business on the second banking day following the Settlement
@@ -1558,7 +1558,7 @@ module Increase
1558
1558
  #
1559
1559
  # @param administrative_returns_expected_by [Time]
1560
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
1561
+ # by. This follows the Nacha guidelines for return windows, which are: "In
1562
1562
  # general, return entries must be received by the RDFI’s ACH Operator by its
1563
1563
  # deposit deadline for the return entry to be made available to the ODFI no later
1564
1564
  # than the opening of business on the second banking day following the Settlement
@@ -151,13 +151,7 @@ module Increase
151
151
  optional :standard_entry_class_code,
152
152
  enum: -> { Increase::ACHTransferCreateParams::StandardEntryClassCode }
153
153
 
154
- # @!attribute transaction_timing
155
- # The timing of the transaction.
156
- #
157
- # @return [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming, nil]
158
- optional :transaction_timing, enum: -> { Increase::ACHTransferCreateParams::TransactionTiming }
159
-
160
- # @!method initialize(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: {})
154
+ # @!method initialize(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: {})
161
155
  # @param account_id [String] The Increase identifier for the account that will send the transfer.
162
156
  #
163
157
  # @param amount [Integer]
@@ -245,9 +239,6 @@ module Increase
245
239
  # to use for the transfer. If not provided, the default is
246
240
  # `corporate_credit_or_debit`.
247
241
  #
248
- # @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming]
249
- # The timing of the transaction.
250
- #
251
242
  # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
252
243
 
253
244
  class Addenda < Increase::Internal::Type::BaseModel
@@ -487,20 +478,6 @@ module Increase
487
478
  # @!method self.values
488
479
  # @return [Array<Symbol>]
489
480
  end
490
-
491
- # The timing of the transaction.
492
- module TransactionTiming
493
- extend Increase::Internal::Type::Enum
494
-
495
- # A Transaction will be created immediately.
496
- SYNCHRONOUS = :synchronous
497
-
498
- # A Transaction will be created when the funds settle at the Federal Reserve.
499
- ASYNCHRONOUS = :asynchronous
500
-
501
- # @!method self.values
502
- # @return [Array<Symbol>]
503
- end
504
481
  end
505
482
  end
506
483
  end
@@ -72,6 +72,42 @@ module Increase
72
72
  # @return [Integer]
73
73
  required :due_balance, Integer
74
74
 
75
+ # @!attribute due_fees
76
+ # The fees on the loan that are due and unpaid.
77
+ #
78
+ # @return [Integer, nil]
79
+ required :due_fees, Integer, nil?: true
80
+
81
+ # @!attribute due_interest
82
+ # The interest on the loan that is due and unpaid.
83
+ #
84
+ # @return [Integer, nil]
85
+ required :due_interest, Integer, nil?: true
86
+
87
+ # @!attribute due_principal
88
+ # The principal on the loan that is due and unpaid.
89
+ #
90
+ # @return [Integer, nil]
91
+ required :due_principal, Integer, nil?: true
92
+
93
+ # @!attribute not_due_fees
94
+ # The fees on the loan that are not yet due.
95
+ #
96
+ # @return [Integer, nil]
97
+ required :not_due_fees, Integer, nil?: true
98
+
99
+ # @!attribute not_due_interest
100
+ # The interest on the loan that is not yet due.
101
+ #
102
+ # @return [Integer, nil]
103
+ required :not_due_interest, Integer, nil?: true
104
+
105
+ # @!attribute not_due_principal
106
+ # The principal on the loan that is not yet due.
107
+ #
108
+ # @return [Integer, nil]
109
+ required :not_due_principal, Integer, nil?: true
110
+
75
111
  # @!attribute past_due_balance
76
112
  # The amount past due on the loan.
77
113
  #
@@ -84,7 +120,7 @@ module Increase
84
120
  # @return [Increase::Models::BalanceLookup::Loan::Receivables, nil]
85
121
  required :receivables, -> { Increase::BalanceLookup::Loan::Receivables }, nil?: true
86
122
 
87
- # @!method initialize(due_at:, due_balance:, past_due_balance:, receivables:)
123
+ # @!method initialize(due_at:, due_balance:, due_fees:, due_interest:, due_principal:, not_due_fees:, not_due_interest:, not_due_principal:, past_due_balance:, receivables:)
88
124
  # The loan balances for the Account.
89
125
  #
90
126
  # @param due_at [Time, nil]
@@ -93,6 +129,18 @@ module Increase
93
129
  #
94
130
  # @param due_balance [Integer] The total amount due on the loan.
95
131
  #
132
+ # @param due_fees [Integer, nil] The fees on the loan that are due and unpaid.
133
+ #
134
+ # @param due_interest [Integer, nil] The interest on the loan that is due and unpaid.
135
+ #
136
+ # @param due_principal [Integer, nil] The principal on the loan that is due and unpaid.
137
+ #
138
+ # @param not_due_fees [Integer, nil] The fees on the loan that are not yet due.
139
+ #
140
+ # @param not_due_interest [Integer, nil] The interest on the loan that is not yet due.
141
+ #
142
+ # @param not_due_principal [Integer, nil] The principal on the loan that is not yet due.
143
+ #
96
144
  # @param past_due_balance [Integer] The amount past due on the loan.
97
145
  #
98
146
  # @param receivables [Increase::Models::BalanceLookup::Loan::Receivables, nil]
@@ -29,6 +29,12 @@ module Increase
29
29
  # @return [Boolean, nil]
30
30
  optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
31
31
 
32
+ # @!attribute date_of_birth
33
+ # The person's date of birth in YYYY-MM-DD format.
34
+ #
35
+ # @return [Date, nil]
36
+ optional :date_of_birth, Date
37
+
32
38
  # @!attribute identification
33
39
  # A means of verifying the person's identity.
34
40
  #
@@ -51,7 +57,7 @@ module Increase
51
57
  optional :prongs,
52
58
  -> { Increase::Internal::Type::ArrayOf[enum: Increase::BeneficialOwnerUpdateParams::Prong] }
53
59
 
54
- # @!method initialize(entity_beneficial_owner_id:, address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil, prongs: nil, request_options: {})
60
+ # @!method initialize(entity_beneficial_owner_id:, address: nil, confirmed_no_us_tax_id: nil, date_of_birth: nil, identification: nil, name: nil, prongs: nil, request_options: {})
55
61
  # @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
56
62
  #
57
63
  # @param address [Increase::Models::BeneficialOwnerUpdateParams::Address]
@@ -64,6 +70,8 @@ module Increase
64
70
  # tax id (either a Social Security Number or Individual Taxpayer Identification
65
71
  # Number).
66
72
  #
73
+ # @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
74
+ #
67
75
  # @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
68
76
  # A means of verifying the person's identity.
69
77
  #
@@ -34,6 +34,13 @@ module Increase
34
34
  # @return [String]
35
35
  required :bin, String
36
36
 
37
+ # @!attribute cardholder_name
38
+ # The name of the cardholder. Used to respond to Account Name Inquiry requests
39
+ # from acquirers in Card Validations.
40
+ #
41
+ # @return [Increase::Models::Card::CardholderName, nil]
42
+ required :cardholder_name, -> { Increase::Card::CardholderName }, nil?: true
43
+
37
44
  # @!attribute created_at
38
45
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
39
46
  # the Card was created.
@@ -100,7 +107,7 @@ module Increase
100
107
  # @return [Symbol, Increase::Models::Card::Type]
101
108
  required :type, enum: -> { Increase::Card::Type }
102
109
 
103
- # @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
110
+ # @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, cardholder_name:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
104
111
  # Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work
105
112
  # for online purchases after you create them. All cards work on a good funds
106
113
  # model, and maintain a maximum limit of 100% of the Account’s available balance
@@ -118,6 +125,10 @@ module Increase
118
125
  #
119
126
  # @param bin [String] The Bank Identification Number (BIN) of the Card.
120
127
  #
128
+ # @param cardholder_name [Increase::Models::Card::CardholderName, nil]
129
+ # The name of the cardholder. Used to respond to Account Name Inquiry requests
130
+ # from acquirers in Card Validations.
131
+ #
121
132
  # @param created_at [Time]
122
133
  # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
123
134
  # the Card was created.
@@ -613,6 +624,37 @@ module Increase
613
624
  # @param state [String, nil] The US state of the billing address.
614
625
  end
615
626
 
627
+ # @see Increase::Models::Card#cardholder_name
628
+ class CardholderName < Increase::Internal::Type::BaseModel
629
+ # @!attribute first
630
+ # The cardholder's first name.
631
+ #
632
+ # @return [String]
633
+ required :first, String
634
+
635
+ # @!attribute last
636
+ # The cardholder's last name.
637
+ #
638
+ # @return [String]
639
+ required :last, String
640
+
641
+ # @!attribute middle
642
+ # The cardholder's middle name.
643
+ #
644
+ # @return [String, nil]
645
+ required :middle, String, nil?: true
646
+
647
+ # @!method initialize(first:, last:, middle:)
648
+ # The name of the cardholder. Used to respond to Account Name Inquiry requests
649
+ # from acquirers in Card Validations.
650
+ #
651
+ # @param first [String] The cardholder's first name.
652
+ #
653
+ # @param last [String] The cardholder's last name.
654
+ #
655
+ # @param middle [String, nil] The cardholder's middle name.
656
+ end
657
+
616
658
  # @see Increase::Models::Card#digital_wallet
617
659
  class DigitalWallet < Increase::Internal::Type::BaseModel
618
660
  # @!attribute digital_card_profile_id
@@ -25,6 +25,13 @@ module Increase
25
25
  # @return [Increase::Models::CardCreateParams::BillingAddress, nil]
26
26
  optional :billing_address, -> { Increase::CardCreateParams::BillingAddress }
27
27
 
28
+ # @!attribute cardholder_name
29
+ # The name of the cardholder. Used to respond to Account Name Inquiry requests
30
+ # from acquirers in Card Validations.
31
+ #
32
+ # @return [Increase::Models::CardCreateParams::CardholderName, nil]
33
+ optional :cardholder_name, -> { Increase::CardCreateParams::CardholderName }
34
+
28
35
  # @!attribute description
29
36
  # The description you choose to give the card.
30
37
  #
@@ -48,7 +55,7 @@ module Increase
48
55
  # @return [String, nil]
49
56
  optional :entity_id, String
50
57
 
51
- # @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
58
+ # @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
52
59
  # @param account_id [String] The Account the card should belong to.
53
60
  #
54
61
  # @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
@@ -56,6 +63,10 @@ module Increase
56
63
  #
57
64
  # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
58
65
  #
66
+ # @param cardholder_name [Increase::Models::CardCreateParams::CardholderName]
67
+ # The name of the cardholder. Used to respond to Account Name Inquiry requests
68
+ # from acquirers in Card Validations.
69
+ #
59
70
  # @param description [String] The description you choose to give the card.
60
71
  #
61
72
  # @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
@@ -519,6 +530,36 @@ module Increase
519
530
  # @param line2 [String] The second line of the billing address.
520
531
  end
521
532
 
533
+ class CardholderName < Increase::Internal::Type::BaseModel
534
+ # @!attribute first
535
+ # The cardholder's first name.
536
+ #
537
+ # @return [String]
538
+ required :first, String
539
+
540
+ # @!attribute last
541
+ # The cardholder's last name.
542
+ #
543
+ # @return [String]
544
+ required :last, String
545
+
546
+ # @!attribute middle
547
+ # The cardholder's middle name.
548
+ #
549
+ # @return [String, nil]
550
+ optional :middle, String
551
+
552
+ # @!method initialize(first:, last:, middle: nil)
553
+ # The name of the cardholder. Used to respond to Account Name Inquiry requests
554
+ # from acquirers in Card Validations.
555
+ #
556
+ # @param first [String] The cardholder's first name.
557
+ #
558
+ # @param last [String] The cardholder's last name.
559
+ #
560
+ # @param middle [String] The cardholder's middle name.
561
+ end
562
+
522
563
  class DigitalWallet < Increase::Internal::Type::BaseModel
523
564
  # @!attribute digital_card_profile_id
524
565
  # The digital card profile assigned to this digital card.
@@ -275,7 +275,7 @@ module Increase
275
275
  # The Card Dispute has been won and no further action can be taken.
276
276
  WON = :won
277
277
 
278
- # The Card Dispute has been reviewed and rejected, please review the explanation for more details.
278
+ # The Card Dispute was rejected before it was submitted to the network, either by Increase or because the user withdrew it. Please review the explanation for more details.
279
279
  REJECTED = :rejected
280
280
 
281
281
  # @!method self.values
@@ -150,7 +150,7 @@ module Increase
150
150
  # The Card Dispute has been won and no further action can be taken.
151
151
  WON = :won
152
152
 
153
- # The Card Dispute has been reviewed and rejected, please review the explanation for more details.
153
+ # The Card Dispute was rejected before it was submitted to the network, either by Increase or because the user withdrew it. Please review the explanation for more details.
154
154
  REJECTED = :rejected
155
155
 
156
156
  # @!method self.values
@@ -1512,6 +1512,16 @@ module Increase
1512
1512
  # @return [Integer, nil]
1513
1513
  required :network_risk_score, Integer, nil?: true
1514
1514
 
1515
+ # @!attribute original_card_payment_id
1516
+ # The ID of the Card Payment containing the original authorization or card
1517
+ # validation this transaction references. For a merchant-initiated transaction,
1518
+ # this is the Card Payment from when the card was first stored, which is typically
1519
+ # where the CVV2 was verified. The reference this is derived from is supplied by
1520
+ # the merchant or their acquirer, so it is not guaranteed to be present.
1521
+ #
1522
+ # @return [String, nil]
1523
+ required :original_card_payment_id, String, nil?: true
1524
+
1515
1525
  # @!attribute pending_transaction_id
1516
1526
  # The identifier of the Pending Transaction associated with this Transaction.
1517
1527
  #
@@ -1580,7 +1590,7 @@ module Increase
1580
1590
  # @return [Increase::Models::CardPayment::Element::CardAuthorization::Verification]
1581
1591
  required :verification, -> { Increase::CardPayment::Element::CardAuthorization::Verification }
1582
1592
 
1583
- # @!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:)
1593
+ # @!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:, original_card_payment_id:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
1584
1594
  # A Card Authorization object. This field will be present in the JSON response if
1585
1595
  # and only if `category` is equal to `card_authorization`. Card Authorizations are
1586
1596
  # temporary holds placed on a customer's funds with the intent to later clear a
@@ -1654,6 +1664,13 @@ module Increase
1654
1664
  # Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
1655
1665
  # score is from 0 to 999, where 999 is the riskiest.
1656
1666
  #
1667
+ # @param original_card_payment_id [String, nil]
1668
+ # The ID of the Card Payment containing the original authorization or card
1669
+ # validation this transaction references. For a merchant-initiated transaction,
1670
+ # this is the Card Payment from when the card was first stored, which is typically
1671
+ # where the CVV2 was verified. The reference this is derived from is supplied by
1672
+ # the merchant or their acquirer, so it is not guaranteed to be present.
1673
+ #
1657
1674
  # @param pending_transaction_id [String, nil]
1658
1675
  # The identifier of the Pending Transaction associated with this Transaction.
1659
1676
  #
@@ -532,6 +532,12 @@ module Increase
532
532
  # @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>]
533
533
  required :payer, -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payer] }
534
534
 
535
+ # @!attribute physical_check_batch_id
536
+ # The identifier of the Physical Check Batch that this check is a part of.
537
+ #
538
+ # @return [String, nil]
539
+ required :physical_check_batch_id, String, nil?: true
540
+
535
541
  # @!attribute recipient_name
536
542
  # The name that will be printed on the check.
537
543
  #
@@ -570,7 +576,7 @@ module Increase
570
576
  required :tracking_updates,
571
577
  -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate] }
572
578
 
573
- # @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, recipient_name:, return_address:, return_address_name:, shipping_method:, signature:, tracking_updates:)
579
+ # @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, physical_check_batch_id:, recipient_name:, return_address:, return_address_name:, shipping_method:, signature:, tracking_updates:)
574
580
  # Details relating to the physical check that Increase will print and mail. Will
575
581
  # be present if and only if `fulfillment_method` is equal to `physical_check`.
576
582
  #
@@ -589,6 +595,9 @@ module Increase
589
595
  # The payer of the check. This will be printed on the top-left portion of the
590
596
  # check and defaults to the return address if unspecified.
591
597
  #
598
+ # @param physical_check_batch_id [String, nil]
599
+ # The identifier of the Physical Check Batch that this check is a part of.
600
+ #
592
601
  # @param recipient_name [String] The name that will be printed on the check.
593
602
  #
594
603
  # @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil]
@@ -876,6 +885,9 @@ module Increase
876
885
  # The transfer has been canceled.
877
886
  CANCELED = :canceled
878
887
 
888
+ # The transfer is waiting for its Physical Check Batch to be completed.
889
+ PENDING_BATCH_COMPLETING = :pending_batch_completing
890
+
879
891
  # The transfer is pending submission.
880
892
  PENDING_SUBMISSION = :pending_submission
881
893
 
@@ -151,7 +151,8 @@ module Increase
151
151
 
152
152
  class PhysicalCheck < Increase::Internal::Type::BaseModel
153
153
  # @!attribute mailing_address
154
- # Details for where Increase will mail the check.
154
+ # Details for where Increase will mail the check. When `physical_check_batch_id`
155
+ # is set, the address must match the Physical Check Batch.
155
156
  #
156
157
  # @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::MailingAddress]
157
158
  required :mailing_address, -> { Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress }
@@ -199,10 +200,16 @@ module Increase
199
200
  # @return [String, nil]
200
201
  optional :note, String
201
202
 
203
+ # @!attribute physical_check_batch_id
204
+ # The identifier of the Physical Check Batch to mail this check as a part of.
205
+ #
206
+ # @return [String, nil]
207
+ optional :physical_check_batch_id, String
208
+
202
209
  # @!attribute return_address
203
- # The return address to be printed on the check. If omitted this will default to
204
- # an Increase-owned address that will mark checks as delivery failed and shred
205
- # them.
210
+ # Details for where the courier will return the check to if it is unable to be
211
+ # delivered. Defaults to an Increase-owned address that will mark checks as
212
+ # delivery failed and shred them.
206
213
  #
207
214
  # @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress, nil]
208
215
  optional :return_address, -> { Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress }
@@ -229,13 +236,14 @@ module Increase
229
236
  # @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::Signature, nil]
230
237
  optional :signature, -> { Increase::CheckTransferCreateParams::PhysicalCheck::Signature }
231
238
 
232
- # @!method initialize(mailing_address:, memo:, payer:, recipient_name:, attachment_file_id: nil, check_voucher_image_file_id: nil, note: nil, return_address: nil, return_address_name: nil, shipping_method: nil, signature: nil)
239
+ # @!method initialize(mailing_address:, memo:, payer:, recipient_name:, attachment_file_id: nil, check_voucher_image_file_id: nil, note: nil, physical_check_batch_id: nil, return_address: nil, return_address_name: nil, shipping_method: nil, signature: nil)
233
240
  # Details relating to the physical check that Increase will print and mail. This
234
241
  # is required if `fulfillment_method` is equal to `physical_check`. It must not be
235
242
  # included if any other `fulfillment_method` is provided.
236
243
  #
237
244
  # @param mailing_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::MailingAddress]
238
- # Details for where Increase will mail the check.
245
+ # Details for where Increase will mail the check. When `physical_check_batch_id`
246
+ # is set, the address must match the Physical Check Batch.
239
247
  #
240
248
  # @param memo [String] The descriptor that will be printed on the memo field on the check.
241
249
  #
@@ -258,10 +266,13 @@ module Increase
258
266
  #
259
267
  # @param note [String] The descriptor that will be printed on the letter included with the check.
260
268
  #
269
+ # @param physical_check_batch_id [String]
270
+ # The identifier of the Physical Check Batch to mail this check as a part of.
271
+ #
261
272
  # @param return_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress]
262
- # The return address to be printed on the check. If omitted this will default to
263
- # an Increase-owned address that will mark checks as delivery failed and shred
264
- # them.
273
+ # Details for where the courier will return the check to if it is unable to be
274
+ # delivered. Defaults to an Increase-owned address that will mark checks as
275
+ # delivery failed and shred them.
265
276
  #
266
277
  # @param return_address_name [String]
267
278
  # A custom name to print above the default return address. Cannot be provided
@@ -324,7 +335,8 @@ module Increase
324
335
  optional :phone, String
325
336
 
326
337
  # @!method initialize(city:, line1:, postal_code:, state:, line2: nil, name: nil, phone: nil)
327
- # Details for where Increase will mail the check.
338
+ # Details for where Increase will mail the check. When `physical_check_batch_id`
339
+ # is set, the address must match the Physical Check Batch.
328
340
  #
329
341
  # @param city [String] The city component of the check's destination address.
330
342
  #
@@ -404,9 +416,9 @@ module Increase
404
416
  optional :phone, String
405
417
 
406
418
  # @!method initialize(city:, line1:, name:, postal_code:, state:, line2: nil, phone: nil)
407
- # The return address to be printed on the check. If omitted this will default to
408
- # an Increase-owned address that will mark checks as delivery failed and shred
409
- # them.
419
+ # Details for where the courier will return the check to if it is unable to be
420
+ # delivered. Defaults to an Increase-owned address that will mark checks as
421
+ # delivery failed and shred them.
410
422
  #
411
423
  # @param city [String] The city of the return address.
412
424
  #
@@ -1208,8 +1208,8 @@ module Increase
1208
1208
  # @!attribute ip_address
1209
1209
  # The IP address the Entity accessed reviewed the terms from.
1210
1210
  #
1211
- # @return [String]
1212
- required :ip_address, String
1211
+ # @return [String, nil]
1212
+ required :ip_address, String, nil?: true
1213
1213
 
1214
1214
  # @!attribute terms_url
1215
1215
  # The URL of the terms agreement. This link will be provided by your bank partner.
@@ -1220,7 +1220,7 @@ module Increase
1220
1220
  # @!method initialize(agreed_at:, ip_address:, terms_url:)
1221
1221
  # @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
1222
1222
  #
1223
- # @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
1223
+ # @param ip_address [String, nil] The IP address the Entity accessed reviewed the terms from.
1224
1224
  #
1225
1225
  # @param terms_url [String] The URL of the terms agreement. This link will be provided by your bank partner.
1226
1226
  end
@@ -1832,6 +1832,12 @@ module Increase
1832
1832
  # @return [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
1833
1833
  required :entity_address, -> { Increase::Entity::Validation::Issue::EntityAddress }, nil?: true
1834
1834
 
1835
+ # @!attribute entity_identity
1836
+ # Details when the issue is with the entity's identity verification.
1837
+ #
1838
+ # @return [Increase::Models::Entity::Validation::Issue::EntityIdentity, nil]
1839
+ required :entity_identity, -> { Increase::Entity::Validation::Issue::EntityIdentity }, nil?: true
1840
+
1835
1841
  # @!attribute entity_tax_identifier
1836
1842
  # Details when the issue is with the entity's tax ID.
1837
1843
  #
@@ -1840,7 +1846,7 @@ module Increase
1840
1846
  -> { Increase::Entity::Validation::Issue::EntityTaxIdentifier },
1841
1847
  nil?: true
1842
1848
 
1843
- # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_tax_identifier:)
1849
+ # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_identity:, entity_tax_identifier:)
1844
1850
  # @param beneficial_owner_address [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil]
1845
1851
  # Details when the issue is with a beneficial owner's address.
1846
1852
  #
@@ -1854,6 +1860,9 @@ module Increase
1854
1860
  # @param entity_address [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
1855
1861
  # Details when the issue is with the entity's address.
1856
1862
  #
1863
+ # @param entity_identity [Increase::Models::Entity::Validation::Issue::EntityIdentity, nil]
1864
+ # Details when the issue is with the entity's identity verification.
1865
+ #
1857
1866
  # @param entity_tax_identifier [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil]
1858
1867
  # Details when the issue is with the entity's tax ID.
1859
1868
 
@@ -1920,6 +1929,9 @@ module Increase
1920
1929
  # 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).
1921
1930
  ENTITY_ADDRESS = :entity_address
1922
1931
 
1932
+ # 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).
1933
+ ENTITY_IDENTITY = :entity_identity
1934
+
1923
1935
  # 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).
1924
1936
  BENEFICIAL_OWNER_IDENTITY = :beneficial_owner_identity
1925
1937
 
@@ -1958,6 +1970,12 @@ module Increase
1958
1970
  end
1959
1971
  end
1960
1972
 
1973
+ # @see Increase::Models::Entity::Validation::Issue#entity_identity
1974
+ class EntityIdentity < Increase::Internal::Type::BaseModel
1975
+ # @!method initialize
1976
+ # Details when the issue is with the entity's identity verification.
1977
+ end
1978
+
1961
1979
  # @see Increase::Models::Entity::Validation::Issue#entity_tax_identifier
1962
1980
  class EntityTaxIdentifier < Increase::Internal::Type::BaseModel
1963
1981
  # @!method initialize