increase 1.8.0 → 1.10.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 +4 -4
- data/CHANGELOG.md +17 -0
- data/README.md +1 -1
- data/lib/increase/models/card_payment.rb +3 -0
- data/lib/increase/models/declined_transaction.rb +3 -0
- data/lib/increase/models/physical_card.rb +36 -1
- data/lib/increase/models/simulations/card_authorization_create_params.rb +3 -0
- data/lib/increase/models/wire_drawdown_request.rb +174 -88
- data/lib/increase/models/wire_drawdown_request_create_params.rb +156 -81
- data/lib/increase/resources/wire_drawdown_requests.rb +10 -21
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/card_payment.rbi +7 -0
- data/rbi/increase/models/declined_transaction.rbi +7 -0
- data/rbi/increase/models/physical_card.rbi +56 -0
- data/rbi/increase/models/simulations/card_authorization_create_params.rbi +7 -0
- data/rbi/increase/models/wire_drawdown_request.rbi +239 -95
- data/rbi/increase/models/wire_drawdown_request_create_params.rbi +249 -118
- data/rbi/increase/resources/wire_drawdown_requests.rbi +25 -43
- data/sig/increase/models/card_payment.rbs +4 -0
- data/sig/increase/models/declined_transaction.rbs +4 -0
- data/sig/increase/models/physical_card.rbs +19 -0
- data/sig/increase/models/simulations/card_authorization_create_params.rbs +4 -0
- data/sig/increase/models/wire_drawdown_request.rbs +119 -55
- data/sig/increase/models/wire_drawdown_request_create_params.rbs +123 -61
- data/sig/increase/resources/wire_drawdown_requests.rbs +7 -11
- metadata +2 -2
@@ -8,122 +8,197 @@ module Increase
|
|
8
8
|
include Increase::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
# @!attribute account_number_id
|
11
|
-
# The Account Number to which the
|
11
|
+
# The Account Number to which the debtor should send funds.
|
12
12
|
#
|
13
13
|
# @return [String]
|
14
14
|
required :account_number_id, String
|
15
15
|
|
16
16
|
# @!attribute amount
|
17
|
-
# The amount requested from the
|
17
|
+
# The amount requested from the debtor, in USD cents.
|
18
18
|
#
|
19
19
|
# @return [Integer]
|
20
20
|
required :amount, Integer
|
21
21
|
|
22
|
-
# @!attribute
|
23
|
-
#
|
22
|
+
# @!attribute creditor_address
|
23
|
+
# The creditor's address.
|
24
24
|
#
|
25
|
-
# @return [
|
26
|
-
required :
|
27
|
-
|
28
|
-
# @!attribute recipient_account_number
|
29
|
-
# The drawdown request's recipient's account number.
|
30
|
-
#
|
31
|
-
# @return [String]
|
32
|
-
required :recipient_account_number, String
|
25
|
+
# @return [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress]
|
26
|
+
required :creditor_address, -> { Increase::WireDrawdownRequestCreateParams::CreditorAddress }
|
33
27
|
|
34
|
-
# @!attribute
|
35
|
-
# The
|
28
|
+
# @!attribute creditor_name
|
29
|
+
# The creditor's name.
|
36
30
|
#
|
37
31
|
# @return [String]
|
38
|
-
required :
|
32
|
+
required :creditor_name, String
|
39
33
|
|
40
|
-
# @!attribute
|
41
|
-
# The
|
34
|
+
# @!attribute debtor_account_number
|
35
|
+
# The debtor's account number.
|
42
36
|
#
|
43
37
|
# @return [String]
|
44
|
-
required :
|
45
|
-
|
46
|
-
# @!attribute originator_address_line1
|
47
|
-
# The drawdown request originator's address line 1. This is only necessary if
|
48
|
-
# you're requesting a payment to a commingled account. Otherwise, we'll use the
|
49
|
-
# associated entity's details.
|
50
|
-
#
|
51
|
-
# @return [String, nil]
|
52
|
-
optional :originator_address_line1, String
|
53
|
-
|
54
|
-
# @!attribute originator_address_line2
|
55
|
-
# The drawdown request originator's address line 2. This is only necessary if
|
56
|
-
# you're requesting a payment to a commingled account. Otherwise, we'll use the
|
57
|
-
# associated entity's details.
|
58
|
-
#
|
59
|
-
# @return [String, nil]
|
60
|
-
optional :originator_address_line2, String
|
38
|
+
required :debtor_account_number, String
|
61
39
|
|
62
|
-
# @!attribute
|
63
|
-
# The
|
64
|
-
# you're requesting a payment to a commingled account. Otherwise, we'll use the
|
65
|
-
# associated entity's details.
|
40
|
+
# @!attribute debtor_address
|
41
|
+
# The debtor's address.
|
66
42
|
#
|
67
|
-
# @return [
|
68
|
-
|
43
|
+
# @return [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress]
|
44
|
+
required :debtor_address, -> { Increase::WireDrawdownRequestCreateParams::DebtorAddress }
|
69
45
|
|
70
|
-
# @!attribute
|
71
|
-
# The
|
72
|
-
# requesting a payment to a commingled account. Otherwise, we'll use the
|
73
|
-
# associated entity's details.
|
46
|
+
# @!attribute debtor_name
|
47
|
+
# The debtor's name.
|
74
48
|
#
|
75
|
-
# @return [String
|
76
|
-
|
77
|
-
|
78
|
-
# @!attribute recipient_address_line1
|
79
|
-
# Line 1 of the drawdown request's recipient's address.
|
80
|
-
#
|
81
|
-
# @return [String, nil]
|
82
|
-
optional :recipient_address_line1, String
|
49
|
+
# @return [String]
|
50
|
+
required :debtor_name, String
|
83
51
|
|
84
|
-
# @!attribute
|
85
|
-
#
|
52
|
+
# @!attribute debtor_routing_number
|
53
|
+
# The debtor's routing number.
|
86
54
|
#
|
87
|
-
# @return [String
|
88
|
-
|
55
|
+
# @return [String]
|
56
|
+
required :debtor_routing_number, String
|
89
57
|
|
90
|
-
# @!attribute
|
91
|
-
#
|
58
|
+
# @!attribute unstructured_remittance_information
|
59
|
+
# Remittance information the debtor will see as part of the request.
|
92
60
|
#
|
93
|
-
# @return [String
|
94
|
-
|
61
|
+
# @return [String]
|
62
|
+
required :unstructured_remittance_information, String
|
95
63
|
|
96
|
-
# @!method initialize(account_number_id:, amount:,
|
97
|
-
#
|
98
|
-
# {Increase::Models::WireDrawdownRequestCreateParams} for more details.
|
99
|
-
#
|
100
|
-
# @param account_number_id [String] The Account Number to which the recipient should send funds.
|
101
|
-
#
|
102
|
-
# @param amount [Integer] The amount requested from the recipient, in USD cents.
|
103
|
-
#
|
104
|
-
# @param message_to_recipient [String] A message the recipient will see as part of the request.
|
64
|
+
# @!method initialize(account_number_id:, amount:, creditor_address:, creditor_name:, debtor_account_number:, debtor_address:, debtor_name:, debtor_routing_number:, unstructured_remittance_information:, request_options: {})
|
65
|
+
# @param account_number_id [String] The Account Number to which the debtor should send funds.
|
105
66
|
#
|
106
|
-
# @param
|
67
|
+
# @param amount [Integer] The amount requested from the debtor, in USD cents.
|
107
68
|
#
|
108
|
-
# @param
|
69
|
+
# @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress] The creditor's address.
|
109
70
|
#
|
110
|
-
# @param
|
71
|
+
# @param creditor_name [String] The creditor's name.
|
111
72
|
#
|
112
|
-
# @param
|
73
|
+
# @param debtor_account_number [String] The debtor's account number.
|
113
74
|
#
|
114
|
-
# @param
|
75
|
+
# @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress] The debtor's address.
|
115
76
|
#
|
116
|
-
# @param
|
77
|
+
# @param debtor_name [String] The debtor's name.
|
117
78
|
#
|
118
|
-
# @param
|
79
|
+
# @param debtor_routing_number [String] The debtor's routing number.
|
119
80
|
#
|
120
|
-
# @param
|
121
|
-
#
|
122
|
-
# @param recipient_address_line2 [String] Line 2 of the drawdown request's recipient's address.
|
123
|
-
#
|
124
|
-
# @param recipient_address_line3 [String] Line 3 of the drawdown request's recipient's address.
|
81
|
+
# @param unstructured_remittance_information [String] Remittance information the debtor will see as part of the request.
|
125
82
|
#
|
126
83
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
84
|
+
|
85
|
+
class CreditorAddress < Increase::Internal::Type::BaseModel
|
86
|
+
# @!attribute city
|
87
|
+
# The city, district, town, or village of the address.
|
88
|
+
#
|
89
|
+
# @return [String]
|
90
|
+
required :city, String
|
91
|
+
|
92
|
+
# @!attribute country
|
93
|
+
# The two-letter
|
94
|
+
# [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
|
95
|
+
# the country of the address.
|
96
|
+
#
|
97
|
+
# @return [String]
|
98
|
+
required :country, String
|
99
|
+
|
100
|
+
# @!attribute line1
|
101
|
+
# The first line of the address. This is usually the street number and street.
|
102
|
+
#
|
103
|
+
# @return [String]
|
104
|
+
required :line1, String
|
105
|
+
|
106
|
+
# @!attribute line2
|
107
|
+
# The second line of the address. This might be the floor or room number.
|
108
|
+
#
|
109
|
+
# @return [String, nil]
|
110
|
+
optional :line2, String
|
111
|
+
|
112
|
+
# @!attribute postal_code
|
113
|
+
# The ZIP code of the address.
|
114
|
+
#
|
115
|
+
# @return [String, nil]
|
116
|
+
optional :postal_code, String
|
117
|
+
|
118
|
+
# @!attribute state
|
119
|
+
# The address state.
|
120
|
+
#
|
121
|
+
# @return [String, nil]
|
122
|
+
optional :state, String
|
123
|
+
|
124
|
+
# @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
|
125
|
+
# Some parameter documentations has been truncated, see
|
126
|
+
# {Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress} for more
|
127
|
+
# details.
|
128
|
+
#
|
129
|
+
# The creditor's address.
|
130
|
+
#
|
131
|
+
# @param city [String] The city, district, town, or village of the address.
|
132
|
+
#
|
133
|
+
# @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
|
134
|
+
#
|
135
|
+
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
136
|
+
#
|
137
|
+
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
138
|
+
#
|
139
|
+
# @param postal_code [String] The ZIP code of the address.
|
140
|
+
#
|
141
|
+
# @param state [String] The address state.
|
142
|
+
end
|
143
|
+
|
144
|
+
class DebtorAddress < Increase::Internal::Type::BaseModel
|
145
|
+
# @!attribute city
|
146
|
+
# The city, district, town, or village of the address.
|
147
|
+
#
|
148
|
+
# @return [String]
|
149
|
+
required :city, String
|
150
|
+
|
151
|
+
# @!attribute country
|
152
|
+
# The two-letter
|
153
|
+
# [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
|
154
|
+
# the country of the address.
|
155
|
+
#
|
156
|
+
# @return [String]
|
157
|
+
required :country, String
|
158
|
+
|
159
|
+
# @!attribute line1
|
160
|
+
# The first line of the address. This is usually the street number and street.
|
161
|
+
#
|
162
|
+
# @return [String]
|
163
|
+
required :line1, String
|
164
|
+
|
165
|
+
# @!attribute line2
|
166
|
+
# The second line of the address. This might be the floor or room number.
|
167
|
+
#
|
168
|
+
# @return [String, nil]
|
169
|
+
optional :line2, String
|
170
|
+
|
171
|
+
# @!attribute postal_code
|
172
|
+
# The ZIP code of the address.
|
173
|
+
#
|
174
|
+
# @return [String, nil]
|
175
|
+
optional :postal_code, String
|
176
|
+
|
177
|
+
# @!attribute state
|
178
|
+
# The address state.
|
179
|
+
#
|
180
|
+
# @return [String, nil]
|
181
|
+
optional :state, String
|
182
|
+
|
183
|
+
# @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
|
184
|
+
# Some parameter documentations has been truncated, see
|
185
|
+
# {Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress} for more
|
186
|
+
# details.
|
187
|
+
#
|
188
|
+
# The debtor's address.
|
189
|
+
#
|
190
|
+
# @param city [String] The city, district, town, or village of the address.
|
191
|
+
#
|
192
|
+
# @param country [String] The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alp
|
193
|
+
#
|
194
|
+
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
195
|
+
#
|
196
|
+
# @param line2 [String] The second line of the address. This might be the floor or room number.
|
197
|
+
#
|
198
|
+
# @param postal_code [String] The ZIP code of the address.
|
199
|
+
#
|
200
|
+
# @param state [String] The address state.
|
201
|
+
end
|
127
202
|
end
|
128
203
|
end
|
129
204
|
end
|
@@ -3,38 +3,27 @@
|
|
3
3
|
module Increase
|
4
4
|
module Resources
|
5
5
|
class WireDrawdownRequests
|
6
|
-
# Some parameter documentations has been truncated, see
|
7
|
-
# {Increase::Models::WireDrawdownRequestCreateParams} for more details.
|
8
|
-
#
|
9
6
|
# Create a Wire Drawdown Request
|
10
7
|
#
|
11
|
-
# @overload create(account_number_id:, amount:,
|
12
|
-
#
|
13
|
-
# @param account_number_id [String] The Account Number to which the recipient should send funds.
|
14
|
-
#
|
15
|
-
# @param amount [Integer] The amount requested from the recipient, in USD cents.
|
16
|
-
#
|
17
|
-
# @param message_to_recipient [String] A message the recipient will see as part of the request.
|
18
|
-
#
|
19
|
-
# @param recipient_account_number [String] The drawdown request's recipient's account number.
|
8
|
+
# @overload create(account_number_id:, amount:, creditor_address:, creditor_name:, debtor_account_number:, debtor_address:, debtor_name:, debtor_routing_number:, unstructured_remittance_information:, request_options: {})
|
20
9
|
#
|
21
|
-
# @param
|
10
|
+
# @param account_number_id [String] The Account Number to which the debtor should send funds.
|
22
11
|
#
|
23
|
-
# @param
|
12
|
+
# @param amount [Integer] The amount requested from the debtor, in USD cents.
|
24
13
|
#
|
25
|
-
# @param
|
14
|
+
# @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress] The creditor's address.
|
26
15
|
#
|
27
|
-
# @param
|
16
|
+
# @param creditor_name [String] The creditor's name.
|
28
17
|
#
|
29
|
-
# @param
|
18
|
+
# @param debtor_account_number [String] The debtor's account number.
|
30
19
|
#
|
31
|
-
# @param
|
20
|
+
# @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress] The debtor's address.
|
32
21
|
#
|
33
|
-
# @param
|
22
|
+
# @param debtor_name [String] The debtor's name.
|
34
23
|
#
|
35
|
-
# @param
|
24
|
+
# @param debtor_routing_number [String] The debtor's routing number.
|
36
25
|
#
|
37
|
-
# @param
|
26
|
+
# @param unstructured_remittance_information [String] Remittance information the debtor will see as part of the request.
|
38
27
|
#
|
39
28
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
40
29
|
#
|
data/lib/increase/version.rb
CHANGED
@@ -4151,6 +4151,13 @@ module Increase
|
|
4151
4151
|
Increase::CardPayment::Element::CardDecline::Reason::TaggedSymbol
|
4152
4152
|
)
|
4153
4153
|
|
4154
|
+
# The transaction was suspected to be used by a card tester to test for valid card numbers.
|
4155
|
+
SUSPECTED_CARD_TESTING =
|
4156
|
+
T.let(
|
4157
|
+
:suspected_card_testing,
|
4158
|
+
Increase::CardPayment::Element::CardDecline::Reason::TaggedSymbol
|
4159
|
+
)
|
4160
|
+
|
4154
4161
|
# The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information.
|
4155
4162
|
SUSPECTED_FRAUD =
|
4156
4163
|
T.let(
|
@@ -2066,6 +2066,13 @@ module Increase
|
|
2066
2066
|
Increase::DeclinedTransaction::Source::CardDecline::Reason::TaggedSymbol
|
2067
2067
|
)
|
2068
2068
|
|
2069
|
+
# The transaction was suspected to be used by a card tester to test for valid card numbers.
|
2070
|
+
SUSPECTED_CARD_TESTING =
|
2071
|
+
T.let(
|
2072
|
+
:suspected_card_testing,
|
2073
|
+
Increase::DeclinedTransaction::Source::CardDecline::Reason::TaggedSymbol
|
2074
|
+
)
|
2075
|
+
|
2069
2076
|
# The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information.
|
2070
2077
|
SUSPECTED_FRAUD =
|
2071
2078
|
T.let(
|
@@ -175,6 +175,16 @@ module Increase
|
|
175
175
|
sig { returns(Increase::PhysicalCard::Shipment::Method::TaggedSymbol) }
|
176
176
|
attr_accessor :method_
|
177
177
|
|
178
|
+
# When this physical card should be produced by the card printer. The default
|
179
|
+
# timeline is the day after the card printer receives the order, except for
|
180
|
+
# `FEDEX_PRIORITY_OVERNIGHT` cards, which default to `SAME_DAY`. To use faster
|
181
|
+
# production methods, please reach out to
|
182
|
+
# [support@increase.com](mailto:support@increase.com).
|
183
|
+
sig do
|
184
|
+
returns(Increase::PhysicalCard::Shipment::Schedule::TaggedSymbol)
|
185
|
+
end
|
186
|
+
attr_accessor :schedule
|
187
|
+
|
178
188
|
# The status of this shipment.
|
179
189
|
sig { returns(Increase::PhysicalCard::Shipment::Status::TaggedSymbol) }
|
180
190
|
attr_accessor :status
|
@@ -196,6 +206,7 @@ module Increase
|
|
196
206
|
params(
|
197
207
|
address: Increase::PhysicalCard::Shipment::Address::OrHash,
|
198
208
|
method_: Increase::PhysicalCard::Shipment::Method::OrSymbol,
|
209
|
+
schedule: Increase::PhysicalCard::Shipment::Schedule::OrSymbol,
|
199
210
|
status: Increase::PhysicalCard::Shipment::Status::OrSymbol,
|
200
211
|
tracking:
|
201
212
|
T.nilable(Increase::PhysicalCard::Shipment::Tracking::OrHash)
|
@@ -206,6 +217,12 @@ module Increase
|
|
206
217
|
address:,
|
207
218
|
# The shipping method.
|
208
219
|
method_:,
|
220
|
+
# When this physical card should be produced by the card printer. The default
|
221
|
+
# timeline is the day after the card printer receives the order, except for
|
222
|
+
# `FEDEX_PRIORITY_OVERNIGHT` cards, which default to `SAME_DAY`. To use faster
|
223
|
+
# production methods, please reach out to
|
224
|
+
# [support@increase.com](mailto:support@increase.com).
|
225
|
+
schedule:,
|
209
226
|
# The status of this shipment.
|
210
227
|
status:,
|
211
228
|
# Tracking details for the shipment.
|
@@ -218,6 +235,8 @@ module Increase
|
|
218
235
|
{
|
219
236
|
address: Increase::PhysicalCard::Shipment::Address,
|
220
237
|
method_: Increase::PhysicalCard::Shipment::Method::TaggedSymbol,
|
238
|
+
schedule:
|
239
|
+
Increase::PhysicalCard::Shipment::Schedule::TaggedSymbol,
|
221
240
|
status: Increase::PhysicalCard::Shipment::Status::TaggedSymbol,
|
222
241
|
tracking: T.nilable(Increase::PhysicalCard::Shipment::Tracking)
|
223
242
|
}
|
@@ -347,6 +366,43 @@ module Increase
|
|
347
366
|
end
|
348
367
|
end
|
349
368
|
|
369
|
+
# When this physical card should be produced by the card printer. The default
|
370
|
+
# timeline is the day after the card printer receives the order, except for
|
371
|
+
# `FEDEX_PRIORITY_OVERNIGHT` cards, which default to `SAME_DAY`. To use faster
|
372
|
+
# production methods, please reach out to
|
373
|
+
# [support@increase.com](mailto:support@increase.com).
|
374
|
+
module Schedule
|
375
|
+
extend Increase::Internal::Type::Enum
|
376
|
+
|
377
|
+
TaggedSymbol =
|
378
|
+
T.type_alias do
|
379
|
+
T.all(Symbol, Increase::PhysicalCard::Shipment::Schedule)
|
380
|
+
end
|
381
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
382
|
+
|
383
|
+
# The physical card will be shipped one business day after the order is received by the card printer. A card that is submitted to Increase on a Monday evening (Pacific Time) will ship out on Wednesday.
|
384
|
+
NEXT_DAY =
|
385
|
+
T.let(
|
386
|
+
:next_day,
|
387
|
+
Increase::PhysicalCard::Shipment::Schedule::TaggedSymbol
|
388
|
+
)
|
389
|
+
|
390
|
+
# The physical card will be shipped on the same business day that the order is received by the card printer. A card that is submitted to Increase on a Monday evening (Pacific Time) will ship out on Tuesday.
|
391
|
+
SAME_DAY =
|
392
|
+
T.let(
|
393
|
+
:same_day,
|
394
|
+
Increase::PhysicalCard::Shipment::Schedule::TaggedSymbol
|
395
|
+
)
|
396
|
+
|
397
|
+
sig do
|
398
|
+
override.returns(
|
399
|
+
T::Array[Increase::PhysicalCard::Shipment::Schedule::TaggedSymbol]
|
400
|
+
)
|
401
|
+
end
|
402
|
+
def self.values
|
403
|
+
end
|
404
|
+
end
|
405
|
+
|
350
406
|
# The status of this shipment.
|
351
407
|
module Status
|
352
408
|
extend Increase::Internal::Type::Enum
|
@@ -418,6 +418,13 @@ module Increase
|
|
418
418
|
Increase::Simulations::CardAuthorizationCreateParams::DeclineReason::TaggedSymbol
|
419
419
|
)
|
420
420
|
|
421
|
+
# The transaction was suspected to be used by a card tester to test for valid card numbers.
|
422
|
+
SUSPECTED_CARD_TESTING =
|
423
|
+
T.let(
|
424
|
+
:suspected_card_testing,
|
425
|
+
Increase::Simulations::CardAuthorizationCreateParams::DeclineReason::TaggedSymbol
|
426
|
+
)
|
427
|
+
|
421
428
|
# The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information.
|
422
429
|
SUSPECTED_FRAUD =
|
423
430
|
T.let(
|