increase 1.229.0 → 1.231.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bd594db233cdb40ffc077729f606ec67d6e095614065ef355e30e659587e048f
4
- data.tar.gz: 4be85b5ab95cc8cb4f6e4facdc59c32f6b0caae0b8d35143c67296a0a1640a70
3
+ metadata.gz: 58c7627a38937abda046072a88ffcc381eeb26bfba23b2c818c95c6f0087b5b9
4
+ data.tar.gz: 8c96c7d9bc15223b24874ce73d078415e3bd33ab114ee9c9a5b3644ef8374135
5
5
  SHA512:
6
- metadata.gz: e6f9fa92612a64174b7715fcb5c5e459dddcda9a9b893b6d7734b0bc5b2bc51a72058b635154407eacc0bd60c52b0e5f0ae2449e3ce1c58c06c4cbc173ed28ed
7
- data.tar.gz: 4520f64e15c90b22dedcb15ec4c77c18e2fafeb37f7dcf37ba6ef186d740015a80390d1123777206cbc489ebda246541cc1f04a76793c8885e8ff4d5d192301e
6
+ metadata.gz: 5ac61d0f56eeec37239e9f59f5eab56a507999ba4307596f077f0d7cdfa0c1217b88d89f0f3f3362e528b8d995b08072de277f0eb3ad9b09a4fee04ff38ce880
7
+ data.tar.gz: 9eb19a7fac468dee2c4362b7e39f8b40959feff8730933f0c0c08808f16f84bd6d6e9b69d746b4834ca7699bfbc25d908595710147798c5c52fd3c7d1f8dd9b3
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.231.0 (2026-03-05)
4
+
5
+ Full Changelog: [v1.230.0...v1.231.0](https://github.com/Increase/increase-ruby/compare/v1.230.0...v1.231.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([0924a4a](https://github.com/Increase/increase-ruby/commit/0924a4a54f1510a80b4bac5a2a282c36e94e08a4))
10
+
11
+ ## 1.230.0 (2026-03-05)
12
+
13
+ Full Changelog: [v1.229.0...v1.230.0](https://github.com/Increase/increase-ruby/compare/v1.229.0...v1.230.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([a02c155](https://github.com/Increase/increase-ruby/commit/a02c155f39f7f44a541ad2151e1dfa14cc21c287))
18
+
3
19
  ## 1.229.0 (2026-03-05)
4
20
 
5
21
  Full Changelog: [v1.228.0...v1.229.0](https://github.com/Increase/increase-ruby/compare/v1.228.0...v1.229.0)
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.229.0"
18
+ gem "increase", "~> 1.231.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -0,0 +1,71 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::CheckDeposits#adjustment
7
+ class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute check_deposit_id
12
+ # The identifier of the Check Deposit you wish to adjust.
13
+ #
14
+ # @return [String]
15
+ required :check_deposit_id, String
16
+
17
+ # @!attribute amount
18
+ # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
19
+ # cents). A negative amount means that the funds are being clawed back by the
20
+ # other bank and is a debit to your account. Defaults to the negative of the Check
21
+ # Deposit amount.
22
+ #
23
+ # @return [Integer, nil]
24
+ optional :amount, Integer
25
+
26
+ # @!attribute reason
27
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
28
+ # used for a low quality image that the recipient wasn't able to handle.
29
+ #
30
+ # @return [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason, nil]
31
+ optional :reason, enum: -> { Increase::Simulations::CheckDepositAdjustmentParams::Reason }
32
+
33
+ # @!method initialize(check_deposit_id:, amount: nil, reason: nil, request_options: {})
34
+ # Some parameter documentations has been truncated, see
35
+ # {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
36
+ #
37
+ # @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
38
+ #
39
+ # @param amount [Integer] The adjustment amount in the minor unit of the Check Deposit's currency (e.g., c
40
+ #
41
+ # @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `non_conforming_item`, which is often
42
+ #
43
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
44
+
45
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
46
+ # used for a low quality image that the recipient wasn't able to handle.
47
+ module Reason
48
+ extend Increase::Internal::Type::Enum
49
+
50
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
51
+ LATE_RETURN = :late_return
52
+
53
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
54
+ WRONG_PAYEE_CREDIT = :wrong_payee_credit
55
+
56
+ # The check was deposited with a different amount than what was written on the check.
57
+ ADJUSTED_AMOUNT = :adjusted_amount
58
+
59
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
60
+ NON_CONFORMING_ITEM = :non_conforming_item
61
+
62
+ # The check has already been deposited elsewhere and so this is a duplicate.
63
+ PAID = :paid
64
+
65
+ # @!method self.values
66
+ # @return [Array<Symbol>]
67
+ end
68
+ end
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,68 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ # @see Increase::Resources::Simulations::InboundCheckDeposits#adjustment
7
+ class InboundCheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
8
+ extend Increase::Internal::Type::RequestParameters::Converter
9
+ include Increase::Internal::Type::RequestParameters
10
+
11
+ # @!attribute inbound_check_deposit_id
12
+ # The identifier of the Inbound Check Deposit to adjust.
13
+ #
14
+ # @return [String]
15
+ required :inbound_check_deposit_id, String
16
+
17
+ # @!attribute amount
18
+ # The adjustment amount in cents. Defaults to the amount of the Inbound Check
19
+ # Deposit.
20
+ #
21
+ # @return [Integer, nil]
22
+ optional :amount, Integer
23
+
24
+ # @!attribute reason
25
+ # The reason for the adjustment. Defaults to `wrong_payee_credit`.
26
+ #
27
+ # @return [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason, nil]
28
+ optional :reason, enum: -> { Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason }
29
+
30
+ # @!method initialize(inbound_check_deposit_id:, amount: nil, reason: nil, request_options: {})
31
+ # Some parameter documentations has been truncated, see
32
+ # {Increase::Models::Simulations::InboundCheckDepositAdjustmentParams} for more
33
+ # details.
34
+ #
35
+ # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
36
+ #
37
+ # @param amount [Integer] The adjustment amount in cents. Defaults to the amount of the Inbound Check Depo
38
+ #
39
+ # @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `wrong_payee_credit`.
40
+ #
41
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
42
+
43
+ # The reason for the adjustment. Defaults to `wrong_payee_credit`.
44
+ module Reason
45
+ extend Increase::Internal::Type::Enum
46
+
47
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
48
+ LATE_RETURN = :late_return
49
+
50
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
51
+ WRONG_PAYEE_CREDIT = :wrong_payee_credit
52
+
53
+ # The check was deposited with a different amount than what was written on the check.
54
+ ADJUSTED_AMOUNT = :adjusted_amount
55
+
56
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
57
+ NON_CONFORMING_ITEM = :non_conforming_item
58
+
59
+ # The check has already been deposited elsewhere and so this is a duplicate.
60
+ PAID = :paid
61
+
62
+ # @!method self.values
63
+ # @return [Array<Symbol>]
64
+ end
65
+ end
66
+ end
67
+ end
68
+ end
@@ -4,6 +4,38 @@ module Increase
4
4
  module Resources
5
5
  class Simulations
6
6
  class CheckDeposits
7
+ # Some parameter documentations has been truncated, see
8
+ # {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
9
+ #
10
+ # Simulates the creation of a
11
+ # [Check Deposit Adjustment](#check-deposit-adjustments) on a
12
+ # [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
13
+ # of `submitted`.
14
+ #
15
+ # @overload adjustment(check_deposit_id, amount: nil, reason: nil, request_options: {})
16
+ #
17
+ # @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
18
+ #
19
+ # @param amount [Integer] The adjustment amount in the minor unit of the Check Deposit's currency (e.g., c
20
+ #
21
+ # @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `non_conforming_item`, which is often
22
+ #
23
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
24
+ #
25
+ # @return [Increase::Models::CheckDeposit]
26
+ #
27
+ # @see Increase::Models::Simulations::CheckDepositAdjustmentParams
28
+ def adjustment(check_deposit_id, params = {})
29
+ parsed, options = Increase::Simulations::CheckDepositAdjustmentParams.dump_request(params)
30
+ @client.request(
31
+ method: :post,
32
+ path: ["simulations/check_deposits/%1$s/adjustment", check_deposit_id],
33
+ body: parsed,
34
+ model: Increase::CheckDeposit,
35
+ options: options
36
+ )
37
+ end
38
+
7
39
  # Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
8
40
  # factors like poor image quality. This Check Deposit must first have a `status`
9
41
  # of `pending`.
@@ -41,6 +41,37 @@ module Increase
41
41
  )
42
42
  end
43
43
 
44
+ # Some parameter documentations has been truncated, see
45
+ # {Increase::Models::Simulations::InboundCheckDepositAdjustmentParams} for more
46
+ # details.
47
+ #
48
+ # Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit
49
+ # must have a `status` of `accepted`.
50
+ #
51
+ # @overload adjustment(inbound_check_deposit_id, amount: nil, reason: nil, request_options: {})
52
+ #
53
+ # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
54
+ #
55
+ # @param amount [Integer] The adjustment amount in cents. Defaults to the amount of the Inbound Check Depo
56
+ #
57
+ # @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `wrong_payee_credit`.
58
+ #
59
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
60
+ #
61
+ # @return [Increase::Models::InboundCheckDeposit]
62
+ #
63
+ # @see Increase::Models::Simulations::InboundCheckDepositAdjustmentParams
64
+ def adjustment(inbound_check_deposit_id, params = {})
65
+ parsed, options = Increase::Simulations::InboundCheckDepositAdjustmentParams.dump_request(params)
66
+ @client.request(
67
+ method: :post,
68
+ path: ["simulations/inbound_check_deposits/%1$s/adjustment", inbound_check_deposit_id],
69
+ body: parsed,
70
+ model: Increase::InboundCheckDeposit,
71
+ options: options
72
+ )
73
+ end
74
+
44
75
  # @api private
45
76
  #
46
77
  # @param client [Increase::Client]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.229.0"
4
+ VERSION = "1.231.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -304,6 +304,7 @@ require_relative "increase/models/simulations/card_refund_create_params"
304
304
  require_relative "increase/models/simulations/card_reversal_create_params"
305
305
  require_relative "increase/models/simulations/card_settlement_create_params"
306
306
  require_relative "increase/models/simulations/card_token_create_params"
307
+ require_relative "increase/models/simulations/check_deposit_adjustment_params"
307
308
  require_relative "increase/models/simulations/check_deposit_reject_params"
308
309
  require_relative "increase/models/simulations/check_deposit_return_params"
309
310
  require_relative "increase/models/simulations/check_deposit_submit_params"
@@ -312,6 +313,7 @@ require_relative "increase/models/simulations/digital_wallet_token_request_creat
312
313
  require_relative "increase/models/simulations/digital_wallet_token_request_create_response"
313
314
  require_relative "increase/models/simulations/export_create_params"
314
315
  require_relative "increase/models/simulations/inbound_ach_transfer_create_params"
316
+ require_relative "increase/models/simulations/inbound_check_deposit_adjustment_params"
315
317
  require_relative "increase/models/simulations/inbound_check_deposit_create_params"
316
318
  require_relative "increase/models/simulations/inbound_fednow_transfer_create_params"
317
319
  require_relative "increase/models/simulations/inbound_mail_item_create_params"
@@ -0,0 +1,151 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(
13
+ Increase::Simulations::CheckDepositAdjustmentParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The identifier of the Check Deposit you wish to adjust.
19
+ sig { returns(String) }
20
+ attr_accessor :check_deposit_id
21
+
22
+ # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
23
+ # cents). A negative amount means that the funds are being clawed back by the
24
+ # other bank and is a debit to your account. Defaults to the negative of the Check
25
+ # Deposit amount.
26
+ sig { returns(T.nilable(Integer)) }
27
+ attr_reader :amount
28
+
29
+ sig { params(amount: Integer).void }
30
+ attr_writer :amount
31
+
32
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
33
+ # used for a low quality image that the recipient wasn't able to handle.
34
+ sig do
35
+ returns(
36
+ T.nilable(
37
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol
38
+ )
39
+ )
40
+ end
41
+ attr_reader :reason
42
+
43
+ sig do
44
+ params(
45
+ reason:
46
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol
47
+ ).void
48
+ end
49
+ attr_writer :reason
50
+
51
+ sig do
52
+ params(
53
+ check_deposit_id: String,
54
+ amount: Integer,
55
+ reason:
56
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
57
+ request_options: Increase::RequestOptions::OrHash
58
+ ).returns(T.attached_class)
59
+ end
60
+ def self.new(
61
+ # The identifier of the Check Deposit you wish to adjust.
62
+ check_deposit_id:,
63
+ # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
64
+ # cents). A negative amount means that the funds are being clawed back by the
65
+ # other bank and is a debit to your account. Defaults to the negative of the Check
66
+ # Deposit amount.
67
+ amount: nil,
68
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
69
+ # used for a low quality image that the recipient wasn't able to handle.
70
+ reason: nil,
71
+ request_options: {}
72
+ )
73
+ end
74
+
75
+ sig do
76
+ override.returns(
77
+ {
78
+ check_deposit_id: String,
79
+ amount: Integer,
80
+ reason:
81
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
82
+ request_options: Increase::RequestOptions
83
+ }
84
+ )
85
+ end
86
+ def to_hash
87
+ end
88
+
89
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
90
+ # used for a low quality image that the recipient wasn't able to handle.
91
+ module Reason
92
+ extend Increase::Internal::Type::Enum
93
+
94
+ TaggedSymbol =
95
+ T.type_alias do
96
+ T.all(
97
+ Symbol,
98
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason
99
+ )
100
+ end
101
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
102
+
103
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
104
+ LATE_RETURN =
105
+ T.let(
106
+ :late_return,
107
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
108
+ )
109
+
110
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
111
+ WRONG_PAYEE_CREDIT =
112
+ T.let(
113
+ :wrong_payee_credit,
114
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
115
+ )
116
+
117
+ # The check was deposited with a different amount than what was written on the check.
118
+ ADJUSTED_AMOUNT =
119
+ T.let(
120
+ :adjusted_amount,
121
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
122
+ )
123
+
124
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
125
+ NON_CONFORMING_ITEM =
126
+ T.let(
127
+ :non_conforming_item,
128
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
129
+ )
130
+
131
+ # The check has already been deposited elsewhere and so this is a duplicate.
132
+ PAID =
133
+ T.let(
134
+ :paid,
135
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
136
+ )
137
+
138
+ sig do
139
+ override.returns(
140
+ T::Array[
141
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
142
+ ]
143
+ )
144
+ end
145
+ def self.values
146
+ end
147
+ end
148
+ end
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,144 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class InboundCheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(
13
+ Increase::Simulations::InboundCheckDepositAdjustmentParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The identifier of the Inbound Check Deposit to adjust.
19
+ sig { returns(String) }
20
+ attr_accessor :inbound_check_deposit_id
21
+
22
+ # The adjustment amount in cents. Defaults to the amount of the Inbound Check
23
+ # Deposit.
24
+ sig { returns(T.nilable(Integer)) }
25
+ attr_reader :amount
26
+
27
+ sig { params(amount: Integer).void }
28
+ attr_writer :amount
29
+
30
+ # The reason for the adjustment. Defaults to `wrong_payee_credit`.
31
+ sig do
32
+ returns(
33
+ T.nilable(
34
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol
35
+ )
36
+ )
37
+ end
38
+ attr_reader :reason
39
+
40
+ sig do
41
+ params(
42
+ reason:
43
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol
44
+ ).void
45
+ end
46
+ attr_writer :reason
47
+
48
+ sig do
49
+ params(
50
+ inbound_check_deposit_id: String,
51
+ amount: Integer,
52
+ reason:
53
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol,
54
+ request_options: Increase::RequestOptions::OrHash
55
+ ).returns(T.attached_class)
56
+ end
57
+ def self.new(
58
+ # The identifier of the Inbound Check Deposit to adjust.
59
+ inbound_check_deposit_id:,
60
+ # The adjustment amount in cents. Defaults to the amount of the Inbound Check
61
+ # Deposit.
62
+ amount: nil,
63
+ # The reason for the adjustment. Defaults to `wrong_payee_credit`.
64
+ reason: nil,
65
+ request_options: {}
66
+ )
67
+ end
68
+
69
+ sig do
70
+ override.returns(
71
+ {
72
+ inbound_check_deposit_id: String,
73
+ amount: Integer,
74
+ reason:
75
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol,
76
+ request_options: Increase::RequestOptions
77
+ }
78
+ )
79
+ end
80
+ def to_hash
81
+ end
82
+
83
+ # The reason for the adjustment. Defaults to `wrong_payee_credit`.
84
+ module Reason
85
+ extend Increase::Internal::Type::Enum
86
+
87
+ TaggedSymbol =
88
+ T.type_alias do
89
+ T.all(
90
+ Symbol,
91
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason
92
+ )
93
+ end
94
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
95
+
96
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
97
+ LATE_RETURN =
98
+ T.let(
99
+ :late_return,
100
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
101
+ )
102
+
103
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
104
+ WRONG_PAYEE_CREDIT =
105
+ T.let(
106
+ :wrong_payee_credit,
107
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
108
+ )
109
+
110
+ # The check was deposited with a different amount than what was written on the check.
111
+ ADJUSTED_AMOUNT =
112
+ T.let(
113
+ :adjusted_amount,
114
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
115
+ )
116
+
117
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
118
+ NON_CONFORMING_ITEM =
119
+ T.let(
120
+ :non_conforming_item,
121
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
122
+ )
123
+
124
+ # The check has already been deposited elsewhere and so this is a duplicate.
125
+ PAID =
126
+ T.let(
127
+ :paid,
128
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
129
+ )
130
+
131
+ sig do
132
+ override.returns(
133
+ T::Array[
134
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
135
+ ]
136
+ )
137
+ end
138
+ def self.values
139
+ end
140
+ end
141
+ end
142
+ end
143
+ end
144
+ end
@@ -4,6 +4,34 @@ module Increase
4
4
  module Resources
5
5
  class Simulations
6
6
  class CheckDeposits
7
+ # Simulates the creation of a
8
+ # [Check Deposit Adjustment](#check-deposit-adjustments) on a
9
+ # [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
10
+ # of `submitted`.
11
+ sig do
12
+ params(
13
+ check_deposit_id: String,
14
+ amount: Integer,
15
+ reason:
16
+ Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
17
+ request_options: Increase::RequestOptions::OrHash
18
+ ).returns(Increase::CheckDeposit)
19
+ end
20
+ def adjustment(
21
+ # The identifier of the Check Deposit you wish to adjust.
22
+ check_deposit_id,
23
+ # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
24
+ # cents). A negative amount means that the funds are being clawed back by the
25
+ # other bank and is a debit to your account. Defaults to the negative of the Check
26
+ # Deposit amount.
27
+ amount: nil,
28
+ # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
29
+ # used for a low quality image that the recipient wasn't able to handle.
30
+ reason: nil,
31
+ request_options: {}
32
+ )
33
+ end
34
+
7
35
  # Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
8
36
  # factors like poor image quality. This Check Deposit must first have a `status`
9
37
  # of `pending`.
@@ -35,6 +35,29 @@ module Increase
35
35
  )
36
36
  end
37
37
 
38
+ # Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit
39
+ # must have a `status` of `accepted`.
40
+ sig do
41
+ params(
42
+ inbound_check_deposit_id: String,
43
+ amount: Integer,
44
+ reason:
45
+ Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol,
46
+ request_options: Increase::RequestOptions::OrHash
47
+ ).returns(Increase::InboundCheckDeposit)
48
+ end
49
+ def adjustment(
50
+ # The identifier of the Inbound Check Deposit to adjust.
51
+ inbound_check_deposit_id,
52
+ # The adjustment amount in cents. Defaults to the amount of the Inbound Check
53
+ # Deposit.
54
+ amount: nil,
55
+ # The reason for the adjustment. Defaults to `wrong_payee_credit`.
56
+ reason: nil,
57
+ request_options: {}
58
+ )
59
+ end
60
+
38
61
  # @api private
39
62
  sig { params(client: Increase::Client).returns(T.attached_class) }
40
63
  def self.new(client:)
@@ -0,0 +1,72 @@
1
+ module Increase
2
+ module Models
3
+ module Simulations
4
+ type check_deposit_adjustment_params =
5
+ {
6
+ check_deposit_id: String,
7
+ amount: Integer,
8
+ reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
9
+ }
10
+ & Increase::Internal::Type::request_parameters
11
+
12
+ class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
13
+ extend Increase::Internal::Type::RequestParameters::Converter
14
+ include Increase::Internal::Type::RequestParameters
15
+
16
+ attr_accessor check_deposit_id: String
17
+
18
+ attr_reader amount: Integer?
19
+
20
+ def amount=: (Integer) -> Integer
21
+
22
+ attr_reader reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason?
23
+
24
+ def reason=: (
25
+ Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
26
+ ) -> Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
27
+
28
+ def initialize: (
29
+ check_deposit_id: String,
30
+ ?amount: Integer,
31
+ ?reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
32
+ ?request_options: Increase::request_opts
33
+ ) -> void
34
+
35
+ def to_hash: -> {
36
+ check_deposit_id: String,
37
+ amount: Integer,
38
+ reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
39
+ request_options: Increase::RequestOptions
40
+ }
41
+
42
+ type reason =
43
+ :late_return
44
+ | :wrong_payee_credit
45
+ | :adjusted_amount
46
+ | :non_conforming_item
47
+ | :paid
48
+
49
+ module Reason
50
+ extend Increase::Internal::Type::Enum
51
+
52
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
53
+ LATE_RETURN: :late_return
54
+
55
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
56
+ WRONG_PAYEE_CREDIT: :wrong_payee_credit
57
+
58
+ # The check was deposited with a different amount than what was written on the check.
59
+ ADJUSTED_AMOUNT: :adjusted_amount
60
+
61
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
62
+ NON_CONFORMING_ITEM: :non_conforming_item
63
+
64
+ # The check has already been deposited elsewhere and so this is a duplicate.
65
+ PAID: :paid
66
+
67
+ def self?.values: -> ::Array[Increase::Models::Simulations::CheckDepositAdjustmentParams::reason]
68
+ end
69
+ end
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,72 @@
1
+ module Increase
2
+ module Models
3
+ module Simulations
4
+ type inbound_check_deposit_adjustment_params =
5
+ {
6
+ inbound_check_deposit_id: String,
7
+ amount: Integer,
8
+ reason: Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason
9
+ }
10
+ & Increase::Internal::Type::request_parameters
11
+
12
+ class InboundCheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
13
+ extend Increase::Internal::Type::RequestParameters::Converter
14
+ include Increase::Internal::Type::RequestParameters
15
+
16
+ attr_accessor inbound_check_deposit_id: String
17
+
18
+ attr_reader amount: Integer?
19
+
20
+ def amount=: (Integer) -> Integer
21
+
22
+ attr_reader reason: Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason?
23
+
24
+ def reason=: (
25
+ Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason
26
+ ) -> Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason
27
+
28
+ def initialize: (
29
+ inbound_check_deposit_id: String,
30
+ ?amount: Integer,
31
+ ?reason: Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason,
32
+ ?request_options: Increase::request_opts
33
+ ) -> void
34
+
35
+ def to_hash: -> {
36
+ inbound_check_deposit_id: String,
37
+ amount: Integer,
38
+ reason: Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason,
39
+ request_options: Increase::RequestOptions
40
+ }
41
+
42
+ type reason =
43
+ :late_return
44
+ | :wrong_payee_credit
45
+ | :adjusted_amount
46
+ | :non_conforming_item
47
+ | :paid
48
+
49
+ module Reason
50
+ extend Increase::Internal::Type::Enum
51
+
52
+ # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
53
+ LATE_RETURN: :late_return
54
+
55
+ # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
56
+ WRONG_PAYEE_CREDIT: :wrong_payee_credit
57
+
58
+ # The check was deposited with a different amount than what was written on the check.
59
+ ADJUSTED_AMOUNT: :adjusted_amount
60
+
61
+ # The recipient was not able to process the check. This usually happens for e.g., low quality images.
62
+ NON_CONFORMING_ITEM: :non_conforming_item
63
+
64
+ # The check has already been deposited elsewhere and so this is a duplicate.
65
+ PAID: :paid
66
+
67
+ def self?.values: -> ::Array[Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason]
68
+ end
69
+ end
70
+ end
71
+ end
72
+ end
@@ -2,6 +2,13 @@ module Increase
2
2
  module Resources
3
3
  class Simulations
4
4
  class CheckDeposits
5
+ def adjustment: (
6
+ String check_deposit_id,
7
+ ?amount: Integer,
8
+ ?reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
9
+ ?request_options: Increase::request_opts
10
+ ) -> Increase::CheckDeposit
11
+
5
12
  def reject: (
6
13
  String check_deposit_id,
7
14
  ?request_options: Increase::request_opts
@@ -10,6 +10,13 @@ module Increase
10
10
  ?request_options: Increase::request_opts
11
11
  ) -> Increase::InboundCheckDeposit
12
12
 
13
+ def adjustment: (
14
+ String inbound_check_deposit_id,
15
+ ?amount: Integer,
16
+ ?reason: Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason,
17
+ ?request_options: Increase::request_opts
18
+ ) -> Increase::InboundCheckDeposit
19
+
13
20
  def initialize: (client: Increase::Client) -> void
14
21
  end
15
22
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: increase
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.229.0
4
+ version: 1.231.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase
@@ -321,6 +321,7 @@ files:
321
321
  - lib/increase/models/simulations/card_reversal_create_params.rb
322
322
  - lib/increase/models/simulations/card_settlement_create_params.rb
323
323
  - lib/increase/models/simulations/card_token_create_params.rb
324
+ - lib/increase/models/simulations/check_deposit_adjustment_params.rb
324
325
  - lib/increase/models/simulations/check_deposit_reject_params.rb
325
326
  - lib/increase/models/simulations/check_deposit_return_params.rb
326
327
  - lib/increase/models/simulations/check_deposit_submit_params.rb
@@ -329,6 +330,7 @@ files:
329
330
  - lib/increase/models/simulations/digital_wallet_token_request_create_response.rb
330
331
  - lib/increase/models/simulations/export_create_params.rb
331
332
  - lib/increase/models/simulations/inbound_ach_transfer_create_params.rb
333
+ - lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb
332
334
  - lib/increase/models/simulations/inbound_check_deposit_create_params.rb
333
335
  - lib/increase/models/simulations/inbound_fednow_transfer_create_params.rb
334
336
  - lib/increase/models/simulations/inbound_mail_item_create_params.rb
@@ -730,6 +732,7 @@ files:
730
732
  - rbi/increase/models/simulations/card_reversal_create_params.rbi
731
733
  - rbi/increase/models/simulations/card_settlement_create_params.rbi
732
734
  - rbi/increase/models/simulations/card_token_create_params.rbi
735
+ - rbi/increase/models/simulations/check_deposit_adjustment_params.rbi
733
736
  - rbi/increase/models/simulations/check_deposit_reject_params.rbi
734
737
  - rbi/increase/models/simulations/check_deposit_return_params.rbi
735
738
  - rbi/increase/models/simulations/check_deposit_submit_params.rbi
@@ -738,6 +741,7 @@ files:
738
741
  - rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi
739
742
  - rbi/increase/models/simulations/export_create_params.rbi
740
743
  - rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi
744
+ - rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi
741
745
  - rbi/increase/models/simulations/inbound_check_deposit_create_params.rbi
742
746
  - rbi/increase/models/simulations/inbound_fednow_transfer_create_params.rbi
743
747
  - rbi/increase/models/simulations/inbound_mail_item_create_params.rbi
@@ -1138,6 +1142,7 @@ files:
1138
1142
  - sig/increase/models/simulations/card_reversal_create_params.rbs
1139
1143
  - sig/increase/models/simulations/card_settlement_create_params.rbs
1140
1144
  - sig/increase/models/simulations/card_token_create_params.rbs
1145
+ - sig/increase/models/simulations/check_deposit_adjustment_params.rbs
1141
1146
  - sig/increase/models/simulations/check_deposit_reject_params.rbs
1142
1147
  - sig/increase/models/simulations/check_deposit_return_params.rbs
1143
1148
  - sig/increase/models/simulations/check_deposit_submit_params.rbs
@@ -1146,6 +1151,7 @@ files:
1146
1151
  - sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs
1147
1152
  - sig/increase/models/simulations/export_create_params.rbs
1148
1153
  - sig/increase/models/simulations/inbound_ach_transfer_create_params.rbs
1154
+ - sig/increase/models/simulations/inbound_check_deposit_adjustment_params.rbs
1149
1155
  - sig/increase/models/simulations/inbound_check_deposit_create_params.rbs
1150
1156
  - sig/increase/models/simulations/inbound_fednow_transfer_create_params.rbs
1151
1157
  - sig/increase/models/simulations/inbound_mail_item_create_params.rbs