increase 1.47.0 → 1.49.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.
@@ -19,196 +19,201 @@ module Increase
19
19
  sig { returns(Integer) }
20
20
  attr_accessor :amount
21
21
 
22
- # The drawdown request's beneficiary's account number.
22
+ # The creditor's account number.
23
23
  sig { returns(String) }
24
- attr_accessor :beneficiary_account_number
24
+ attr_accessor :creditor_account_number
25
25
 
26
- # The drawdown request's beneficiary's routing number.
26
+ # The creditor's routing number.
27
27
  sig { returns(String) }
28
- attr_accessor :beneficiary_routing_number
28
+ attr_accessor :creditor_routing_number
29
29
 
30
30
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
31
31
  # requested. Will always be "USD".
32
32
  sig { returns(String) }
33
33
  attr_accessor :currency
34
34
 
35
- # A message from the drawdown request's originator.
36
- sig { returns(String) }
37
- attr_accessor :message_to_recipient
38
-
39
- # The drawdown request's originator's account number.
40
- sig { returns(String) }
41
- attr_accessor :originator_account_number
42
-
43
- # The drawdown request's originator's routing number.
44
- sig { returns(String) }
45
- attr_accessor :originator_routing_number
46
-
47
35
  # The Account Number to which the recipient of this request is being requested to
48
36
  # send funds from.
49
37
  sig { returns(String) }
50
38
  attr_accessor :recipient_account_number_id
51
39
 
52
- # Line 1 of the drawdown request's beneficiary's address.
40
+ # A free-form address field set by the sender representing the first line of the
41
+ # creditor's address.
42
+ sig { returns(T.nilable(String)) }
43
+ attr_reader :creditor_address_line1
44
+
45
+ sig { params(creditor_address_line1: String).void }
46
+ attr_writer :creditor_address_line1
47
+
48
+ # A free-form address field set by the sender representing the second line of the
49
+ # creditor's address.
50
+ sig { returns(T.nilable(String)) }
51
+ attr_reader :creditor_address_line2
52
+
53
+ sig { params(creditor_address_line2: String).void }
54
+ attr_writer :creditor_address_line2
55
+
56
+ # A free-form address field set by the sender representing the third line of the
57
+ # creditor's address.
53
58
  sig { returns(T.nilable(String)) }
54
- attr_reader :beneficiary_address_line1
59
+ attr_reader :creditor_address_line3
55
60
 
56
- sig { params(beneficiary_address_line1: String).void }
57
- attr_writer :beneficiary_address_line1
61
+ sig { params(creditor_address_line3: String).void }
62
+ attr_writer :creditor_address_line3
58
63
 
59
- # Line 2 of the drawdown request's beneficiary's address.
64
+ # A free-form name field set by the sender representing the creditor's name.
60
65
  sig { returns(T.nilable(String)) }
61
- attr_reader :beneficiary_address_line2
66
+ attr_reader :creditor_name
62
67
 
63
- sig { params(beneficiary_address_line2: String).void }
64
- attr_writer :beneficiary_address_line2
68
+ sig { params(creditor_name: String).void }
69
+ attr_writer :creditor_name
65
70
 
66
- # Line 3 of the drawdown request's beneficiary's address.
71
+ # The debtor's account number.
67
72
  sig { returns(T.nilable(String)) }
68
- attr_reader :beneficiary_address_line3
73
+ attr_reader :debtor_account_number
69
74
 
70
- sig { params(beneficiary_address_line3: String).void }
71
- attr_writer :beneficiary_address_line3
75
+ sig { params(debtor_account_number: String).void }
76
+ attr_writer :debtor_account_number
72
77
 
73
- # The drawdown request's beneficiary's name.
78
+ # A free-form address field set by the sender representing the first line of the
79
+ # debtor's address.
74
80
  sig { returns(T.nilable(String)) }
75
- attr_reader :beneficiary_name
81
+ attr_reader :debtor_address_line1
76
82
 
77
- sig { params(beneficiary_name: String).void }
78
- attr_writer :beneficiary_name
83
+ sig { params(debtor_address_line1: String).void }
84
+ attr_writer :debtor_address_line1
79
85
 
80
- # Line 1 of the drawdown request's originator's address.
86
+ # A free-form address field set by the sender representing the second line of the
87
+ # debtor's address.
81
88
  sig { returns(T.nilable(String)) }
82
- attr_reader :originator_address_line1
89
+ attr_reader :debtor_address_line2
83
90
 
84
- sig { params(originator_address_line1: String).void }
85
- attr_writer :originator_address_line1
91
+ sig { params(debtor_address_line2: String).void }
92
+ attr_writer :debtor_address_line2
86
93
 
87
- # Line 2 of the drawdown request's originator's address.
94
+ # A free-form address field set by the sender.
88
95
  sig { returns(T.nilable(String)) }
89
- attr_reader :originator_address_line2
96
+ attr_reader :debtor_address_line3
90
97
 
91
- sig { params(originator_address_line2: String).void }
92
- attr_writer :originator_address_line2
98
+ sig { params(debtor_address_line3: String).void }
99
+ attr_writer :debtor_address_line3
93
100
 
94
- # Line 3 of the drawdown request's originator's address.
101
+ # A free-form name field set by the sender representing the debtor's name.
95
102
  sig { returns(T.nilable(String)) }
96
- attr_reader :originator_address_line3
103
+ attr_reader :debtor_name
97
104
 
98
- sig { params(originator_address_line3: String).void }
99
- attr_writer :originator_address_line3
105
+ sig { params(debtor_name: String).void }
106
+ attr_writer :debtor_name
100
107
 
101
- # The drawdown request's originator's name.
108
+ # The debtor's routing number.
102
109
  sig { returns(T.nilable(String)) }
103
- attr_reader :originator_name
110
+ attr_reader :debtor_routing_number
104
111
 
105
- sig { params(originator_name: String).void }
106
- attr_writer :originator_name
112
+ sig { params(debtor_routing_number: String).void }
113
+ attr_writer :debtor_routing_number
107
114
 
108
- # Line 1 of the information conveyed from the originator of the message to the
109
- # beneficiary.
115
+ # A free-form reference string set by the sender, to help identify the transfer.
110
116
  sig { returns(T.nilable(String)) }
111
- attr_reader :originator_to_beneficiary_information_line1
117
+ attr_reader :end_to_end_identification
112
118
 
113
- sig { params(originator_to_beneficiary_information_line1: String).void }
114
- attr_writer :originator_to_beneficiary_information_line1
119
+ sig { params(end_to_end_identification: String).void }
120
+ attr_writer :end_to_end_identification
115
121
 
116
- # Line 2 of the information conveyed from the originator of the message to the
117
- # beneficiary.
122
+ # The sending bank's identifier for the wire transfer.
118
123
  sig { returns(T.nilable(String)) }
119
- attr_reader :originator_to_beneficiary_information_line2
124
+ attr_reader :instruction_identification
120
125
 
121
- sig { params(originator_to_beneficiary_information_line2: String).void }
122
- attr_writer :originator_to_beneficiary_information_line2
126
+ sig { params(instruction_identification: String).void }
127
+ attr_writer :instruction_identification
123
128
 
124
- # Line 3 of the information conveyed from the originator of the message to the
125
- # beneficiary.
129
+ # The Unique End-to-end Transaction Reference
130
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
131
+ # of the transfer.
126
132
  sig { returns(T.nilable(String)) }
127
- attr_reader :originator_to_beneficiary_information_line3
133
+ attr_reader :unique_end_to_end_transaction_reference
128
134
 
129
- sig { params(originator_to_beneficiary_information_line3: String).void }
130
- attr_writer :originator_to_beneficiary_information_line3
135
+ sig { params(unique_end_to_end_transaction_reference: String).void }
136
+ attr_writer :unique_end_to_end_transaction_reference
131
137
 
132
- # Line 4 of the information conveyed from the originator of the message to the
133
- # beneficiary.
138
+ # A free-form message set by the sender.
134
139
  sig { returns(T.nilable(String)) }
135
- attr_reader :originator_to_beneficiary_information_line4
140
+ attr_reader :unstructured_remittance_information
136
141
 
137
- sig { params(originator_to_beneficiary_information_line4: String).void }
138
- attr_writer :originator_to_beneficiary_information_line4
142
+ sig { params(unstructured_remittance_information: String).void }
143
+ attr_writer :unstructured_remittance_information
139
144
 
140
145
  sig do
141
146
  params(
142
147
  amount: Integer,
143
- beneficiary_account_number: String,
144
- beneficiary_routing_number: String,
148
+ creditor_account_number: String,
149
+ creditor_routing_number: String,
145
150
  currency: String,
146
- message_to_recipient: String,
147
- originator_account_number: String,
148
- originator_routing_number: String,
149
151
  recipient_account_number_id: String,
150
- beneficiary_address_line1: String,
151
- beneficiary_address_line2: String,
152
- beneficiary_address_line3: String,
153
- beneficiary_name: String,
154
- originator_address_line1: String,
155
- originator_address_line2: String,
156
- originator_address_line3: String,
157
- originator_name: String,
158
- originator_to_beneficiary_information_line1: String,
159
- originator_to_beneficiary_information_line2: String,
160
- originator_to_beneficiary_information_line3: String,
161
- originator_to_beneficiary_information_line4: String,
152
+ creditor_address_line1: String,
153
+ creditor_address_line2: String,
154
+ creditor_address_line3: String,
155
+ creditor_name: String,
156
+ debtor_account_number: String,
157
+ debtor_address_line1: String,
158
+ debtor_address_line2: String,
159
+ debtor_address_line3: String,
160
+ debtor_name: String,
161
+ debtor_routing_number: String,
162
+ end_to_end_identification: String,
163
+ instruction_identification: String,
164
+ unique_end_to_end_transaction_reference: String,
165
+ unstructured_remittance_information: String,
162
166
  request_options: Increase::RequestOptions::OrHash
163
167
  ).returns(T.attached_class)
164
168
  end
165
169
  def self.new(
166
170
  # The amount being requested in cents.
167
171
  amount:,
168
- # The drawdown request's beneficiary's account number.
169
- beneficiary_account_number:,
170
- # The drawdown request's beneficiary's routing number.
171
- beneficiary_routing_number:,
172
+ # The creditor's account number.
173
+ creditor_account_number:,
174
+ # The creditor's routing number.
175
+ creditor_routing_number:,
172
176
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
173
177
  # requested. Will always be "USD".
174
178
  currency:,
175
- # A message from the drawdown request's originator.
176
- message_to_recipient:,
177
- # The drawdown request's originator's account number.
178
- originator_account_number:,
179
- # The drawdown request's originator's routing number.
180
- originator_routing_number:,
181
179
  # The Account Number to which the recipient of this request is being requested to
182
180
  # send funds from.
183
181
  recipient_account_number_id:,
184
- # Line 1 of the drawdown request's beneficiary's address.
185
- beneficiary_address_line1: nil,
186
- # Line 2 of the drawdown request's beneficiary's address.
187
- beneficiary_address_line2: nil,
188
- # Line 3 of the drawdown request's beneficiary's address.
189
- beneficiary_address_line3: nil,
190
- # The drawdown request's beneficiary's name.
191
- beneficiary_name: nil,
192
- # Line 1 of the drawdown request's originator's address.
193
- originator_address_line1: nil,
194
- # Line 2 of the drawdown request's originator's address.
195
- originator_address_line2: nil,
196
- # Line 3 of the drawdown request's originator's address.
197
- originator_address_line3: nil,
198
- # The drawdown request's originator's name.
199
- originator_name: nil,
200
- # Line 1 of the information conveyed from the originator of the message to the
201
- # beneficiary.
202
- originator_to_beneficiary_information_line1: nil,
203
- # Line 2 of the information conveyed from the originator of the message to the
204
- # beneficiary.
205
- originator_to_beneficiary_information_line2: nil,
206
- # Line 3 of the information conveyed from the originator of the message to the
207
- # beneficiary.
208
- originator_to_beneficiary_information_line3: nil,
209
- # Line 4 of the information conveyed from the originator of the message to the
210
- # beneficiary.
211
- originator_to_beneficiary_information_line4: nil,
182
+ # A free-form address field set by the sender representing the first line of the
183
+ # creditor's address.
184
+ creditor_address_line1: nil,
185
+ # A free-form address field set by the sender representing the second line of the
186
+ # creditor's address.
187
+ creditor_address_line2: nil,
188
+ # A free-form address field set by the sender representing the third line of the
189
+ # creditor's address.
190
+ creditor_address_line3: nil,
191
+ # A free-form name field set by the sender representing the creditor's name.
192
+ creditor_name: nil,
193
+ # The debtor's account number.
194
+ debtor_account_number: nil,
195
+ # A free-form address field set by the sender representing the first line of the
196
+ # debtor's address.
197
+ debtor_address_line1: nil,
198
+ # A free-form address field set by the sender representing the second line of the
199
+ # debtor's address.
200
+ debtor_address_line2: nil,
201
+ # A free-form address field set by the sender.
202
+ debtor_address_line3: nil,
203
+ # A free-form name field set by the sender representing the debtor's name.
204
+ debtor_name: nil,
205
+ # The debtor's routing number.
206
+ debtor_routing_number: nil,
207
+ # A free-form reference string set by the sender, to help identify the transfer.
208
+ end_to_end_identification: nil,
209
+ # The sending bank's identifier for the wire transfer.
210
+ instruction_identification: nil,
211
+ # The Unique End-to-end Transaction Reference
212
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
213
+ # of the transfer.
214
+ unique_end_to_end_transaction_reference: nil,
215
+ # A free-form message set by the sender.
216
+ unstructured_remittance_information: nil,
212
217
  request_options: {}
213
218
  )
214
219
  end
@@ -217,25 +222,24 @@ module Increase
217
222
  override.returns(
218
223
  {
219
224
  amount: Integer,
220
- beneficiary_account_number: String,
221
- beneficiary_routing_number: String,
225
+ creditor_account_number: String,
226
+ creditor_routing_number: String,
222
227
  currency: String,
223
- message_to_recipient: String,
224
- originator_account_number: String,
225
- originator_routing_number: String,
226
228
  recipient_account_number_id: String,
227
- beneficiary_address_line1: String,
228
- beneficiary_address_line2: String,
229
- beneficiary_address_line3: String,
230
- beneficiary_name: String,
231
- originator_address_line1: String,
232
- originator_address_line2: String,
233
- originator_address_line3: String,
234
- originator_name: String,
235
- originator_to_beneficiary_information_line1: String,
236
- originator_to_beneficiary_information_line2: String,
237
- originator_to_beneficiary_information_line3: String,
238
- originator_to_beneficiary_information_line4: String,
229
+ creditor_address_line1: String,
230
+ creditor_address_line2: String,
231
+ creditor_address_line3: String,
232
+ creditor_name: String,
233
+ debtor_account_number: String,
234
+ debtor_address_line1: String,
235
+ debtor_address_line2: String,
236
+ debtor_address_line3: String,
237
+ debtor_name: String,
238
+ debtor_routing_number: String,
239
+ end_to_end_identification: String,
240
+ instruction_identification: String,
241
+ unique_end_to_end_transaction_reference: String,
242
+ unstructured_remittance_information: String,
239
243
  request_options: Increase::RequestOptions
240
244
  }
241
245
  )
@@ -0,0 +1,32 @@
1
+ # typed: strong
2
+
3
+ module Increase
4
+ module Models
5
+ module Simulations
6
+ class WireDrawdownRequestSubmitParams < 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::WireDrawdownRequestSubmitParams,
14
+ Increase::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ sig do
19
+ params(request_options: Increase::RequestOptions::OrHash).returns(
20
+ T.attached_class
21
+ )
22
+ end
23
+ def self.new(request_options: {})
24
+ end
25
+
26
+ sig { override.returns({ request_options: Increase::RequestOptions }) }
27
+ def to_hash
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
@@ -9,75 +9,75 @@ module Increase
9
9
  sig do
10
10
  params(
11
11
  amount: Integer,
12
- beneficiary_account_number: String,
13
- beneficiary_routing_number: String,
12
+ creditor_account_number: String,
13
+ creditor_routing_number: String,
14
14
  currency: String,
15
- message_to_recipient: String,
16
- originator_account_number: String,
17
- originator_routing_number: String,
18
15
  recipient_account_number_id: String,
19
- beneficiary_address_line1: String,
20
- beneficiary_address_line2: String,
21
- beneficiary_address_line3: String,
22
- beneficiary_name: String,
23
- originator_address_line1: String,
24
- originator_address_line2: String,
25
- originator_address_line3: String,
26
- originator_name: String,
27
- originator_to_beneficiary_information_line1: String,
28
- originator_to_beneficiary_information_line2: String,
29
- originator_to_beneficiary_information_line3: String,
30
- originator_to_beneficiary_information_line4: String,
16
+ creditor_address_line1: String,
17
+ creditor_address_line2: String,
18
+ creditor_address_line3: String,
19
+ creditor_name: String,
20
+ debtor_account_number: String,
21
+ debtor_address_line1: String,
22
+ debtor_address_line2: String,
23
+ debtor_address_line3: String,
24
+ debtor_name: String,
25
+ debtor_routing_number: String,
26
+ end_to_end_identification: String,
27
+ instruction_identification: String,
28
+ unique_end_to_end_transaction_reference: String,
29
+ unstructured_remittance_information: String,
31
30
  request_options: Increase::RequestOptions::OrHash
32
31
  ).returns(Increase::InboundWireDrawdownRequest)
33
32
  end
34
33
  def create(
35
34
  # The amount being requested in cents.
36
35
  amount:,
37
- # The drawdown request's beneficiary's account number.
38
- beneficiary_account_number:,
39
- # The drawdown request's beneficiary's routing number.
40
- beneficiary_routing_number:,
36
+ # The creditor's account number.
37
+ creditor_account_number:,
38
+ # The creditor's routing number.
39
+ creditor_routing_number:,
41
40
  # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
42
41
  # requested. Will always be "USD".
43
42
  currency:,
44
- # A message from the drawdown request's originator.
45
- message_to_recipient:,
46
- # The drawdown request's originator's account number.
47
- originator_account_number:,
48
- # The drawdown request's originator's routing number.
49
- originator_routing_number:,
50
43
  # The Account Number to which the recipient of this request is being requested to
51
44
  # send funds from.
52
45
  recipient_account_number_id:,
53
- # Line 1 of the drawdown request's beneficiary's address.
54
- beneficiary_address_line1: nil,
55
- # Line 2 of the drawdown request's beneficiary's address.
56
- beneficiary_address_line2: nil,
57
- # Line 3 of the drawdown request's beneficiary's address.
58
- beneficiary_address_line3: nil,
59
- # The drawdown request's beneficiary's name.
60
- beneficiary_name: nil,
61
- # Line 1 of the drawdown request's originator's address.
62
- originator_address_line1: nil,
63
- # Line 2 of the drawdown request's originator's address.
64
- originator_address_line2: nil,
65
- # Line 3 of the drawdown request's originator's address.
66
- originator_address_line3: nil,
67
- # The drawdown request's originator's name.
68
- originator_name: nil,
69
- # Line 1 of the information conveyed from the originator of the message to the
70
- # beneficiary.
71
- originator_to_beneficiary_information_line1: nil,
72
- # Line 2 of the information conveyed from the originator of the message to the
73
- # beneficiary.
74
- originator_to_beneficiary_information_line2: nil,
75
- # Line 3 of the information conveyed from the originator of the message to the
76
- # beneficiary.
77
- originator_to_beneficiary_information_line3: nil,
78
- # Line 4 of the information conveyed from the originator of the message to the
79
- # beneficiary.
80
- originator_to_beneficiary_information_line4: nil,
46
+ # A free-form address field set by the sender representing the first line of the
47
+ # creditor's address.
48
+ creditor_address_line1: nil,
49
+ # A free-form address field set by the sender representing the second line of the
50
+ # creditor's address.
51
+ creditor_address_line2: nil,
52
+ # A free-form address field set by the sender representing the third line of the
53
+ # creditor's address.
54
+ creditor_address_line3: nil,
55
+ # A free-form name field set by the sender representing the creditor's name.
56
+ creditor_name: nil,
57
+ # The debtor's account number.
58
+ debtor_account_number: nil,
59
+ # A free-form address field set by the sender representing the first line of the
60
+ # debtor's address.
61
+ debtor_address_line1: nil,
62
+ # A free-form address field set by the sender representing the second line of the
63
+ # debtor's address.
64
+ debtor_address_line2: nil,
65
+ # A free-form address field set by the sender.
66
+ debtor_address_line3: nil,
67
+ # A free-form name field set by the sender representing the debtor's name.
68
+ debtor_name: nil,
69
+ # The debtor's routing number.
70
+ debtor_routing_number: nil,
71
+ # A free-form reference string set by the sender, to help identify the transfer.
72
+ end_to_end_identification: nil,
73
+ # The sending bank's identifier for the wire transfer.
74
+ instruction_identification: nil,
75
+ # The Unique End-to-end Transaction Reference
76
+ # ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
77
+ # of the transfer.
78
+ unique_end_to_end_transaction_reference: nil,
79
+ # A free-form message set by the sender.
80
+ unstructured_remittance_information: nil,
81
81
  request_options: {}
82
82
  )
83
83
  end
@@ -18,6 +18,20 @@ module Increase
18
18
  )
19
19
  end
20
20
 
21
+ # Simulates a Wire Drawdown Request being submitted to Fedwire.
22
+ sig do
23
+ params(
24
+ wire_drawdown_request_id: String,
25
+ request_options: Increase::RequestOptions::OrHash
26
+ ).returns(Increase::WireDrawdownRequest)
27
+ end
28
+ def submit(
29
+ # The identifier of the Wire Drawdown Request you wish to submit.
30
+ wire_drawdown_request_id,
31
+ request_options: {}
32
+ )
33
+ end
34
+
21
35
  # @api private
22
36
  sig { params(client: Increase::Client).returns(T.attached_class) }
23
37
  def self.new(client:)