increase 1.353.0 → 1.355.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 (152) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/increase/client.rb +18 -0
  4. data/lib/increase/models/ach_transfer.rb +3 -3
  5. data/lib/increase/models/beneficial_owner_create_params.rb +1 -1
  6. data/lib/increase/models/beneficial_owner_update_params.rb +1 -1
  7. data/lib/increase/models/card_create_details_token_params.rb +22 -0
  8. data/lib/increase/models/card_details_token.rb +57 -0
  9. data/lib/increase/models/card_payment.rb +29 -1
  10. data/lib/increase/models/declined_transaction.rb +3 -0
  11. data/lib/increase/models/digital_wallet_token.rb +18 -0
  12. data/lib/increase/models/digital_wallet_token_request.rb +307 -0
  13. data/lib/increase/models/digital_wallet_token_request_list_params.rb +99 -0
  14. data/lib/increase/models/digital_wallet_token_request_retrieve_params.rb +22 -0
  15. data/lib/increase/models/digital_wallet_token_transition_params.rb +48 -0
  16. data/lib/increase/models/entity.rb +35 -7
  17. data/lib/increase/models/entity_beneficial_owner.rb +1 -1
  18. data/lib/increase/models/entity_create_params.rb +1 -1
  19. data/lib/increase/models/export.rb +19 -19
  20. data/lib/increase/models/export_create_params.rb +15 -15
  21. data/lib/increase/models/export_list_params.rb +19 -19
  22. data/lib/increase/models/inbound_real_time_payments_request_for_payment.rb +318 -0
  23. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rb +113 -0
  24. data/lib/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rb +25 -0
  25. data/lib/increase/models/inbound_wire_transfer.rb +10 -1
  26. data/lib/increase/models/physical_check_batch.rb +266 -0
  27. data/lib/increase/models/physical_check_batch_cancel_params.rb +22 -0
  28. data/lib/increase/models/physical_check_batch_complete_params.rb +22 -0
  29. data/lib/increase/models/physical_check_batch_create_params.rb +189 -0
  30. data/lib/increase/models/real_time_decision.rb +9 -0
  31. data/lib/increase/models/real_time_decision_action_params.rb +3 -0
  32. data/lib/increase/models/real_time_payments_request_for_payment.rb +658 -0
  33. data/lib/increase/models/real_time_payments_requests_for_payment_cancel_params.rb +64 -0
  34. data/lib/increase/models/real_time_payments_requests_for_payment_create_params.rb +194 -0
  35. data/lib/increase/models/real_time_payments_requests_for_payment_list_params.rb +117 -0
  36. data/lib/increase/models/real_time_payments_requests_for_payment_retrieve_params.rb +23 -0
  37. data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -0
  38. data/lib/increase/models/simulations/entity_update_validation_params.rb +3 -0
  39. data/lib/increase/models/simulations/fednow_transfer_complete_params.rb +103 -0
  40. data/lib/increase/models/simulations/inbound_check_deposit_accept_params.rb +24 -0
  41. data/lib/increase/models/transaction.rb +36 -2
  42. data/lib/increase/models.rb +42 -0
  43. data/lib/increase/resources/cards.rb +23 -0
  44. data/lib/increase/resources/digital_wallet_token_requests.rb +68 -0
  45. data/lib/increase/resources/digital_wallet_tokens.rb +28 -0
  46. data/lib/increase/resources/inbound_real_time_payments_requests_for_payment.rb +79 -0
  47. data/lib/increase/resources/physical_check_batches.rb +86 -0
  48. data/lib/increase/resources/real_time_payments_requests_for_payment.rb +159 -0
  49. data/lib/increase/resources/simulations/fednow_transfers.rb +43 -0
  50. data/lib/increase/resources/simulations/inbound_check_deposits.rb +22 -0
  51. data/lib/increase/resources/simulations.rb +4 -0
  52. data/lib/increase/version.rb +1 -1
  53. data/lib/increase.rb +25 -0
  54. data/rbi/increase/client.rbi +14 -0
  55. data/rbi/increase/models/ach_transfer.rbi +3 -3
  56. data/rbi/increase/models/beneficial_owner_create_params.rbi +1 -1
  57. data/rbi/increase/models/beneficial_owner_update_params.rbi +1 -1
  58. data/rbi/increase/models/card_create_details_token_params.rbi +43 -0
  59. data/rbi/increase/models/card_details_token.rbi +85 -0
  60. data/rbi/increase/models/card_payment.rbi +59 -0
  61. data/rbi/increase/models/declined_transaction.rbi +7 -0
  62. data/rbi/increase/models/digital_wallet_token.rbi +42 -0
  63. data/rbi/increase/models/digital_wallet_token_request.rbi +586 -0
  64. data/rbi/increase/models/digital_wallet_token_request_list_params.rbi +171 -0
  65. data/rbi/increase/models/digital_wallet_token_request_retrieve_params.rbi +46 -0
  66. data/rbi/increase/models/digital_wallet_token_transition_params.rbi +100 -0
  67. data/rbi/increase/models/entity.rbi +71 -6
  68. data/rbi/increase/models/entity_beneficial_owner.rbi +1 -1
  69. data/rbi/increase/models/entity_create_params.rbi +1 -1
  70. data/rbi/increase/models/export.rbi +32 -32
  71. data/rbi/increase/models/export_create_params.rbi +29 -29
  72. data/rbi/increase/models/export_list_params.rbi +37 -37
  73. data/rbi/increase/models/inbound_real_time_payments_request_for_payment.rbi +442 -0
  74. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbi +188 -0
  75. data/rbi/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbi +48 -0
  76. data/rbi/increase/models/inbound_wire_transfer.rbi +8 -0
  77. data/rbi/increase/models/physical_check_batch.rbi +382 -0
  78. data/rbi/increase/models/physical_check_batch_cancel_params.rbi +46 -0
  79. data/rbi/increase/models/physical_check_batch_complete_params.rbi +46 -0
  80. data/rbi/increase/models/physical_check_batch_create_params.rbi +326 -0
  81. data/rbi/increase/models/real_time_decision.rbi +21 -0
  82. data/rbi/increase/models/real_time_decision_action_params.rbi +7 -0
  83. data/rbi/increase/models/real_time_payments_request_for_payment.rbi +1166 -0
  84. data/rbi/increase/models/real_time_payments_requests_for_payment_cancel_params.rbi +136 -0
  85. data/rbi/increase/models/real_time_payments_requests_for_payment_create_params.rbi +303 -0
  86. data/rbi/increase/models/real_time_payments_requests_for_payment_list_params.rbi +192 -0
  87. data/rbi/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbi +46 -0
  88. data/rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi +21 -0
  89. data/rbi/increase/models/simulations/entity_update_validation_params.rbi +7 -0
  90. data/rbi/increase/models/simulations/fednow_transfer_complete_params.rbi +243 -0
  91. data/rbi/increase/models/simulations/inbound_check_deposit_accept_params.rbi +48 -0
  92. data/rbi/increase/models/transaction.rbi +60 -0
  93. data/rbi/increase/models.rbi +50 -0
  94. data/rbi/increase/resources/cards.rbi +17 -0
  95. data/rbi/increase/resources/digital_wallet_token_requests.rbi +52 -0
  96. data/rbi/increase/resources/digital_wallet_tokens.rbi +21 -0
  97. data/rbi/increase/resources/inbound_real_time_payments_requests_for_payment.rbi +62 -0
  98. data/rbi/increase/resources/physical_check_batches.rbi +66 -0
  99. data/rbi/increase/resources/real_time_payments_requests_for_payment.rbi +127 -0
  100. data/rbi/increase/resources/simulations/fednow_transfers.rbi +34 -0
  101. data/rbi/increase/resources/simulations/inbound_check_deposits.rbi +16 -0
  102. data/rbi/increase/resources/simulations.rbi +3 -0
  103. data/sig/increase/client.rbs +8 -0
  104. data/sig/increase/models/ach_transfer.rbs +4 -4
  105. data/sig/increase/models/beneficial_owner_create_params.rbs +1 -1
  106. data/sig/increase/models/beneficial_owner_update_params.rbs +1 -1
  107. data/sig/increase/models/card_create_details_token_params.rbs +23 -0
  108. data/sig/increase/models/card_details_token.rbs +40 -0
  109. data/sig/increase/models/card_payment.rbs +23 -0
  110. data/sig/increase/models/declined_transaction.rbs +4 -0
  111. data/sig/increase/models/digital_wallet_token.rbs +36 -3
  112. data/sig/increase/models/digital_wallet_token_request.rbs +260 -0
  113. data/sig/increase/models/digital_wallet_token_request_list_params.rbs +86 -0
  114. data/sig/increase/models/digital_wallet_token_request_retrieve_params.rbs +24 -0
  115. data/sig/increase/models/digital_wallet_token_transition_params.rbs +48 -0
  116. data/sig/increase/models/entity.rbs +25 -6
  117. data/sig/increase/models/entity_beneficial_owner.rbs +1 -1
  118. data/sig/increase/models/entity_create_params.rbs +1 -1
  119. data/sig/increase/models/export.rbs +28 -28
  120. data/sig/increase/models/export_create_params.rbs +22 -22
  121. data/sig/increase/models/export_list_params.rbs +28 -28
  122. data/sig/increase/models/inbound_real_time_payments_request_for_payment.rbs +200 -0
  123. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_list_params.rbs +93 -0
  124. data/sig/increase/models/inbound_real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  125. data/sig/increase/models/inbound_wire_transfer.rbs +5 -0
  126. data/sig/increase/models/physical_check_batch.rbs +193 -0
  127. data/sig/increase/models/physical_check_batch_cancel_params.rbs +24 -0
  128. data/sig/increase/models/physical_check_batch_complete_params.rbs +24 -0
  129. data/sig/increase/models/physical_check_batch_create_params.rbs +156 -0
  130. data/sig/increase/models/real_time_decision.rbs +14 -2
  131. data/sig/increase/models/real_time_decision_action_params.rbs +4 -0
  132. data/sig/increase/models/real_time_payments_request_for_payment.rbs +513 -0
  133. data/sig/increase/models/real_time_payments_requests_for_payment_cancel_params.rbs +66 -0
  134. data/sig/increase/models/real_time_payments_requests_for_payment_create_params.rbs +149 -0
  135. data/sig/increase/models/real_time_payments_requests_for_payment_list_params.rbs +93 -0
  136. data/sig/increase/models/real_time_payments_requests_for_payment_retrieve_params.rbs +24 -0
  137. data/sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs +12 -0
  138. data/sig/increase/models/simulations/entity_update_validation_params.rbs +4 -0
  139. data/sig/increase/models/simulations/fednow_transfer_complete_params.rbs +122 -0
  140. data/sig/increase/models/simulations/inbound_check_deposit_accept_params.rbs +26 -0
  141. data/sig/increase/models/transaction.rbs +24 -0
  142. data/sig/increase/models.rbs +36 -0
  143. data/sig/increase/resources/cards.rbs +5 -0
  144. data/sig/increase/resources/digital_wallet_token_requests.rbs +20 -0
  145. data/sig/increase/resources/digital_wallet_tokens.rbs +6 -0
  146. data/sig/increase/resources/inbound_real_time_payments_requests_for_payment.rbs +21 -0
  147. data/sig/increase/resources/physical_check_batches.rbs +24 -0
  148. data/sig/increase/resources/real_time_payments_requests_for_payment.rbs +41 -0
  149. data/sig/increase/resources/simulations/fednow_transfers.rbs +15 -0
  150. data/sig/increase/resources/simulations/inbound_check_deposits.rbs +5 -0
  151. data/sig/increase/resources/simulations.rbs +2 -0
  152. metadata +77 -2
@@ -117,12 +117,16 @@ module Increase
117
117
 
118
118
  CardCreateDetailsIframeParams = Increase::Models::CardCreateDetailsIframeParams
119
119
 
120
+ CardCreateDetailsTokenParams = Increase::Models::CardCreateDetailsTokenParams
121
+
120
122
  CardCreateParams = Increase::Models::CardCreateParams
121
123
 
122
124
  CardDetails = Increase::Models::CardDetails
123
125
 
124
126
  CardDetailsParams = Increase::Models::CardDetailsParams
125
127
 
128
+ CardDetailsToken = Increase::Models::CardDetailsToken
129
+
126
130
  CardDispute = Increase::Models::CardDispute
127
131
 
128
132
  CardDisputeCreateParams = Increase::Models::CardDisputeCreateParams
@@ -231,8 +235,16 @@ module Increase
231
235
 
232
236
  DigitalWalletTokenListParams = Increase::Models::DigitalWalletTokenListParams
233
237
 
238
+ DigitalWalletTokenRequest = Increase::Models::DigitalWalletTokenRequest
239
+
240
+ DigitalWalletTokenRequestListParams = Increase::Models::DigitalWalletTokenRequestListParams
241
+
242
+ DigitalWalletTokenRequestRetrieveParams = Increase::Models::DigitalWalletTokenRequestRetrieveParams
243
+
234
244
  DigitalWalletTokenRetrieveParams = Increase::Models::DigitalWalletTokenRetrieveParams
235
245
 
246
+ DigitalWalletTokenTransitionParams = Increase::Models::DigitalWalletTokenTransitionParams
247
+
236
248
  Entity = Increase::Models::Entity
237
249
 
238
250
  EntityArchiveParams = Increase::Models::EntityArchiveParams
@@ -362,6 +374,14 @@ module Increase
362
374
 
363
375
  InboundMailItemRetrieveParams = Increase::Models::InboundMailItemRetrieveParams
364
376
 
377
+ InboundRealTimePaymentsRequestForPayment = Increase::Models::InboundRealTimePaymentsRequestForPayment
378
+
379
+ InboundRealTimePaymentsRequestsForPaymentListParams =
380
+ Increase::Models::InboundRealTimePaymentsRequestsForPaymentListParams
381
+
382
+ InboundRealTimePaymentsRequestsForPaymentRetrieveParams =
383
+ Increase::Models::InboundRealTimePaymentsRequestsForPaymentRetrieveParams
384
+
365
385
  InboundRealTimePaymentsTransfer = Increase::Models::InboundRealTimePaymentsTransfer
366
386
 
367
387
  InboundRealTimePaymentsTransferListParams = Increase::Models::InboundRealTimePaymentsTransferListParams
@@ -475,6 +495,14 @@ module Increase
475
495
 
476
496
  PhysicalCardUpdateParams = Increase::Models::PhysicalCardUpdateParams
477
497
 
498
+ PhysicalCheckBatch = Increase::Models::PhysicalCheckBatch
499
+
500
+ PhysicalCheckBatchCancelParams = Increase::Models::PhysicalCheckBatchCancelParams
501
+
502
+ PhysicalCheckBatchCompleteParams = Increase::Models::PhysicalCheckBatchCompleteParams
503
+
504
+ PhysicalCheckBatchCreateParams = Increase::Models::PhysicalCheckBatchCreateParams
505
+
478
506
  Program = Increase::Models::Program
479
507
 
480
508
  ProgramListParams = Increase::Models::ProgramListParams
@@ -487,6 +515,20 @@ module Increase
487
515
 
488
516
  RealTimeDecisionRetrieveParams = Increase::Models::RealTimeDecisionRetrieveParams
489
517
 
518
+ RealTimePaymentsRequestForPayment = Increase::Models::RealTimePaymentsRequestForPayment
519
+
520
+ RealTimePaymentsRequestsForPaymentCancelParams =
521
+ Increase::Models::RealTimePaymentsRequestsForPaymentCancelParams
522
+
523
+ RealTimePaymentsRequestsForPaymentCreateParams =
524
+ Increase::Models::RealTimePaymentsRequestsForPaymentCreateParams
525
+
526
+ RealTimePaymentsRequestsForPaymentListParams =
527
+ Increase::Models::RealTimePaymentsRequestsForPaymentListParams
528
+
529
+ RealTimePaymentsRequestsForPaymentRetrieveParams =
530
+ Increase::Models::RealTimePaymentsRequestsForPaymentRetrieveParams
531
+
490
532
  RealTimePaymentsTransfer = Increase::Models::RealTimePaymentsTransfer
491
533
 
492
534
  RealTimePaymentsTransferApproveParams = Increase::Models::RealTimePaymentsTransferApproveParams
@@ -172,6 +172,29 @@ module Increase
172
172
  )
173
173
  end
174
174
 
175
+ # Create a short-lived token that authorizes
176
+ # [Card Elements](/documentation/card-elements) to render the details of a Card in
177
+ # your frontend. Mint the token on your server and pass it to the browser; the
178
+ # token is valid for one hour and is scoped to a single Card.
179
+ #
180
+ # @overload create_details_token(card_id, request_options: {})
181
+ #
182
+ # @param card_id [String] The identifier of the Card to mint a details token for.
183
+ #
184
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
185
+ #
186
+ # @return [Increase::Models::CardDetailsToken]
187
+ #
188
+ # @see Increase::Models::CardCreateDetailsTokenParams
189
+ def create_details_token(card_id, params = {})
190
+ @client.request(
191
+ method: :post,
192
+ path: ["cards/%1$s/create_details_token", card_id],
193
+ model: Increase::CardDetailsToken,
194
+ options: params[:request_options]
195
+ )
196
+ end
197
+
175
198
  # Sensitive details for a Card include the primary account number, expiration,
176
199
  # card verification code, and PIN.
177
200
  #
@@ -0,0 +1,68 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class DigitalWalletTokenRequests
6
+ # Retrieve a Digital Wallet Token Request
7
+ #
8
+ # @overload retrieve(digital_wallet_token_request_id, request_options: {})
9
+ #
10
+ # @param digital_wallet_token_request_id [String] The identifier of the Digital Wallet Token Request.
11
+ #
12
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
13
+ #
14
+ # @return [Increase::Models::DigitalWalletTokenRequest]
15
+ #
16
+ # @see Increase::Models::DigitalWalletTokenRequestRetrieveParams
17
+ def retrieve(digital_wallet_token_request_id, params = {})
18
+ @client.request(
19
+ method: :get,
20
+ path: ["digital_wallet_token_requests/%1$s", digital_wallet_token_request_id],
21
+ model: Increase::DigitalWalletTokenRequest,
22
+ options: params[:request_options]
23
+ )
24
+ end
25
+
26
+ # List Digital Wallet Token Requests
27
+ #
28
+ # @overload list(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
29
+ #
30
+ # @param card_id [String] Filter Digital Wallet Token Requests to ones for the specified Card.
31
+ #
32
+ # @param created_at [Increase::Models::DigitalWalletTokenRequestListParams::CreatedAt]
33
+ #
34
+ # @param cursor [String] Return the page of entries after this one.
35
+ #
36
+ # @param limit [Integer]
37
+ # Limit the size of the list that is returned. The default (and maximum) is 100
38
+ # objects.
39
+ #
40
+ # Defaults to `100`.
41
+ #
42
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
43
+ #
44
+ # @return [Increase::Internal::Page<Increase::Models::DigitalWalletTokenRequest>]
45
+ #
46
+ # @see Increase::Models::DigitalWalletTokenRequestListParams
47
+ def list(params = {})
48
+ parsed, options = Increase::DigitalWalletTokenRequestListParams.dump_request(params)
49
+ query = Increase::Internal::Util.encode_query_params(parsed)
50
+ @client.request(
51
+ method: :get,
52
+ path: "digital_wallet_token_requests",
53
+ query: query,
54
+ page: Increase::Internal::Page,
55
+ model: Increase::DigitalWalletTokenRequest,
56
+ options: options
57
+ )
58
+ end
59
+
60
+ # @api private
61
+ #
62
+ # @param client [Increase::Client]
63
+ def initialize(client:)
64
+ @client = client
65
+ end
66
+ end
67
+ end
68
+ end
@@ -57,6 +57,34 @@ module Increase
57
57
  )
58
58
  end
59
59
 
60
+ # Submit a Digital Wallet Token status transition to the card network. The Digital
61
+ # Wallet Token will move to `pending_transitioning` until the card network
62
+ # confirms the transition, and a `digital_wallet_token.updated` webhook will be
63
+ # sent once the transition has been confirmed.
64
+ #
65
+ # @overload transition(digital_wallet_token_id, status:, request_options: {})
66
+ #
67
+ # @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token.
68
+ #
69
+ # @param status [Symbol, Increase::Models::DigitalWalletTokenTransitionParams::Status]
70
+ # The status to transition the Digital Wallet Token to.
71
+ #
72
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
73
+ #
74
+ # @return [Increase::Models::DigitalWalletToken]
75
+ #
76
+ # @see Increase::Models::DigitalWalletTokenTransitionParams
77
+ def transition(digital_wallet_token_id, params)
78
+ parsed, options = Increase::DigitalWalletTokenTransitionParams.dump_request(params)
79
+ @client.request(
80
+ method: :post,
81
+ path: ["digital_wallet_tokens/%1$s/transition", digital_wallet_token_id],
82
+ body: parsed,
83
+ model: Increase::DigitalWalletToken,
84
+ options: options
85
+ )
86
+ end
87
+
60
88
  # @api private
61
89
  #
62
90
  # @param client [Increase::Client]
@@ -0,0 +1,79 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class InboundRealTimePaymentsRequestsForPayment
6
+ # Retrieve an Inbound Real-Time Payments Request for Payment
7
+ #
8
+ # @overload retrieve(inbound_real_time_payments_request_for_payment_id, request_options: {})
9
+ #
10
+ # @param inbound_real_time_payments_request_for_payment_id [String]
11
+ # The identifier of the Inbound Real-Time Payments Request for Payment to get
12
+ # details for.
13
+ #
14
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
15
+ #
16
+ # @return [Increase::Models::InboundRealTimePaymentsRequestForPayment]
17
+ #
18
+ # @see Increase::Models::InboundRealTimePaymentsRequestsForPaymentRetrieveParams
19
+ def retrieve(inbound_real_time_payments_request_for_payment_id, params = {})
20
+ @client.request(
21
+ method: :get,
22
+ path: [
23
+ "inbound_real_time_payments_requests_for_payment/%1$s",
24
+ inbound_real_time_payments_request_for_payment_id
25
+ ],
26
+ model: Increase::InboundRealTimePaymentsRequestForPayment,
27
+ options: params[:request_options]
28
+ )
29
+ end
30
+
31
+ # List Inbound Real-Time Payments Requests for Payment
32
+ #
33
+ # @overload list(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
34
+ #
35
+ # @param account_id [String]
36
+ # Filter Inbound Real-Time Payments Requests for Payment to those belonging to the
37
+ # specified Account.
38
+ #
39
+ # @param account_number_id [String]
40
+ # Filter Inbound Real-Time Payments Requests for Payment to ones belonging to the
41
+ # specified Account Number.
42
+ #
43
+ # @param created_at [Increase::Models::InboundRealTimePaymentsRequestsForPaymentListParams::CreatedAt]
44
+ #
45
+ # @param cursor [String] Return the page of entries after this one.
46
+ #
47
+ # @param limit [Integer]
48
+ # Limit the size of the list that is returned. The default (and maximum) is 100
49
+ # objects.
50
+ #
51
+ # Defaults to `100`.
52
+ #
53
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
54
+ #
55
+ # @return [Increase::Internal::Page<Increase::Models::InboundRealTimePaymentsRequestForPayment>]
56
+ #
57
+ # @see Increase::Models::InboundRealTimePaymentsRequestsForPaymentListParams
58
+ def list(params = {})
59
+ parsed, options = Increase::InboundRealTimePaymentsRequestsForPaymentListParams.dump_request(params)
60
+ query = Increase::Internal::Util.encode_query_params(parsed)
61
+ @client.request(
62
+ method: :get,
63
+ path: "inbound_real_time_payments_requests_for_payment",
64
+ query: query,
65
+ page: Increase::Internal::Page,
66
+ model: Increase::InboundRealTimePaymentsRequestForPayment,
67
+ options: options
68
+ )
69
+ end
70
+
71
+ # @api private
72
+ #
73
+ # @param client [Increase::Client]
74
+ def initialize(client:)
75
+ @client = client
76
+ end
77
+ end
78
+ end
79
+ end
@@ -0,0 +1,86 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class PhysicalCheckBatches
6
+ # Create a Physical Check Batch
7
+ #
8
+ # @overload create(mailing_address:, return_address:, shipping_method: nil, request_options: {})
9
+ #
10
+ # @param mailing_address [Increase::Models::PhysicalCheckBatchCreateParams::MailingAddress]
11
+ # Details for where the parcel will be mailed.
12
+ #
13
+ # @param return_address [Increase::Models::PhysicalCheckBatchCreateParams::ReturnAddress]
14
+ # Details for where the parcel should return if it is unable to be delivered.
15
+ #
16
+ # @param shipping_method [Symbol, Increase::Models::PhysicalCheckBatchCreateParams::ShippingMethod]
17
+ # How to ship the batch.
18
+ #
19
+ # Defaults to `usps_first_class`.
20
+ #
21
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
22
+ #
23
+ # @return [Increase::Models::PhysicalCheckBatch]
24
+ #
25
+ # @see Increase::Models::PhysicalCheckBatchCreateParams
26
+ def create(params)
27
+ parsed, options = Increase::PhysicalCheckBatchCreateParams.dump_request(params)
28
+ @client.request(
29
+ method: :post,
30
+ path: "physical_check_batches",
31
+ body: parsed,
32
+ model: Increase::PhysicalCheckBatch,
33
+ options: options
34
+ )
35
+ end
36
+
37
+ # Cancel a pending Physical Check Batch, which cancels all of its related checks.
38
+ #
39
+ # @overload cancel(physical_check_batch_id, request_options: {})
40
+ #
41
+ # @param physical_check_batch_id [String] The identifier of the pending Physical Check Batch to cancel.
42
+ #
43
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
44
+ #
45
+ # @return [Increase::Models::PhysicalCheckBatch]
46
+ #
47
+ # @see Increase::Models::PhysicalCheckBatchCancelParams
48
+ def cancel(physical_check_batch_id, params = {})
49
+ @client.request(
50
+ method: :post,
51
+ path: ["physical_check_batches/%1$s/cancel", physical_check_batch_id],
52
+ model: Increase::PhysicalCheckBatch,
53
+ options: params[:request_options]
54
+ )
55
+ end
56
+
57
+ # Completing a Physical Check Batch closes it to new Physical Checks and begins
58
+ # the process of printing and mailing it.
59
+ #
60
+ # @overload complete(physical_check_batch_id, request_options: {})
61
+ #
62
+ # @param physical_check_batch_id [String] The identifier of the Physical Check Batch to complete.
63
+ #
64
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
65
+ #
66
+ # @return [Increase::Models::PhysicalCheckBatch]
67
+ #
68
+ # @see Increase::Models::PhysicalCheckBatchCompleteParams
69
+ def complete(physical_check_batch_id, params = {})
70
+ @client.request(
71
+ method: :post,
72
+ path: ["physical_check_batches/%1$s/complete", physical_check_batch_id],
73
+ model: Increase::PhysicalCheckBatch,
74
+ options: params[:request_options]
75
+ )
76
+ end
77
+
78
+ # @api private
79
+ #
80
+ # @param client [Increase::Client]
81
+ def initialize(client:)
82
+ @client = client
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,159 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class RealTimePaymentsRequestsForPayment
6
+ # Create a Real-Time Payments Request for Payment
7
+ #
8
+ # @overload create(account_number_id:, amount:, debtor:, debtor_account_number:, debtor_routing_number:, expires_at:, requested_execution_at:, unstructured_remittance_information:, creditor_name: nil, request_options: {})
9
+ #
10
+ # @param account_number_id [String] The identifier of the Account Number where the funds will land.
11
+ #
12
+ # @param amount [Integer] The requested amount in USD cents. Must be positive.
13
+ #
14
+ # @param debtor [Increase::Models::RealTimePaymentsRequestsForPaymentCreateParams::Debtor]
15
+ # Details of the person being requested to pay.
16
+ #
17
+ # @param debtor_account_number [String] The debtor's account number, which the funds will be requested from.
18
+ #
19
+ # @param debtor_routing_number [String]
20
+ # The debtor's American Bankers' Association (ABA) Routing Transit Number (RTN).
21
+ #
22
+ # @param expires_at [Time]
23
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time after which
24
+ # the request for payment is no longer valid. After this time the debtor's bank
25
+ # should no longer allow the debtor to pay it. Must not be before
26
+ # `requested_execution_at`.
27
+ #
28
+ # @param requested_execution_at [Time]
29
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time by which
30
+ # you are requesting the payment to be made.
31
+ #
32
+ # @param unstructured_remittance_information [String]
33
+ # Unstructured information that will show on the recipient's bank statement.
34
+ #
35
+ # @param creditor_name [String]
36
+ # The name of the creditor requesting the payment. If not provided, defaults to
37
+ # the name of the account's entity.
38
+ #
39
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
40
+ #
41
+ # @return [Increase::Models::RealTimePaymentsRequestForPayment]
42
+ #
43
+ # @see Increase::Models::RealTimePaymentsRequestsForPaymentCreateParams
44
+ def create(params)
45
+ parsed, options = Increase::RealTimePaymentsRequestsForPaymentCreateParams.dump_request(params)
46
+ @client.request(
47
+ method: :post,
48
+ path: "real_time_payments_requests_for_payment",
49
+ body: parsed,
50
+ model: Increase::RealTimePaymentsRequestForPayment,
51
+ options: options
52
+ )
53
+ end
54
+
55
+ # Retrieve a Real-Time Payments Request for Payment
56
+ #
57
+ # @overload retrieve(real_time_payments_request_for_payment_id, request_options: {})
58
+ #
59
+ # @param real_time_payments_request_for_payment_id [String]
60
+ # The identifier of the Real-Time Payments Request for Payment.
61
+ #
62
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
63
+ #
64
+ # @return [Increase::Models::RealTimePaymentsRequestForPayment]
65
+ #
66
+ # @see Increase::Models::RealTimePaymentsRequestsForPaymentRetrieveParams
67
+ def retrieve(real_time_payments_request_for_payment_id, params = {})
68
+ @client.request(
69
+ method: :get,
70
+ path: ["real_time_payments_requests_for_payment/%1$s", real_time_payments_request_for_payment_id],
71
+ model: Increase::RealTimePaymentsRequestForPayment,
72
+ options: params[:request_options]
73
+ )
74
+ end
75
+
76
+ # List Real-Time Payments Requests for Payment
77
+ #
78
+ # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
79
+ #
80
+ # @param account_id [String]
81
+ # Filter Real-Time Payments Requests for Payment to those destined to the
82
+ # specified Account.
83
+ #
84
+ # @param created_at [Increase::Models::RealTimePaymentsRequestsForPaymentListParams::CreatedAt]
85
+ #
86
+ # @param cursor [String] Return the page of entries after this one.
87
+ #
88
+ # @param idempotency_key [String]
89
+ # Filter records to the one with the specified `idempotency_key` you chose for
90
+ # that object. This value is unique across Increase and is used to ensure that a
91
+ # request is only processed once. Learn more about
92
+ # [idempotency](https://increase.com/documentation/idempotency-keys).
93
+ #
94
+ # @param limit [Integer]
95
+ # Limit the size of the list that is returned. The default (and maximum) is 100
96
+ # objects.
97
+ #
98
+ # Defaults to `100`.
99
+ #
100
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
101
+ #
102
+ # @return [Increase::Internal::Page<Increase::Models::RealTimePaymentsRequestForPayment>]
103
+ #
104
+ # @see Increase::Models::RealTimePaymentsRequestsForPaymentListParams
105
+ def list(params = {})
106
+ parsed, options = Increase::RealTimePaymentsRequestsForPaymentListParams.dump_request(params)
107
+ query = Increase::Internal::Util.encode_query_params(parsed)
108
+ @client.request(
109
+ method: :get,
110
+ path: "real_time_payments_requests_for_payment",
111
+ query: query,
112
+ page: Increase::Internal::Page,
113
+ model: Increase::RealTimePaymentsRequestForPayment,
114
+ options: options
115
+ )
116
+ end
117
+
118
+ # Cancels a Real-Time Payments Request for Payment that is still awaiting payment.
119
+ #
120
+ # @overload cancel(real_time_payments_request_for_payment_id, additional_information: nil, reason: nil, request_options: {})
121
+ #
122
+ # @param real_time_payments_request_for_payment_id [String]
123
+ # The identifier of the Real-Time Payments Request for Payment to cancel.
124
+ #
125
+ # @param additional_information [String]
126
+ # Additional information about the cancellation to pass on to the recipient bank.
127
+ #
128
+ # @param reason [Symbol, Increase::Models::RealTimePaymentsRequestsForPaymentCancelParams::Reason]
129
+ # The reason the request for payment is being canceled. Defaults to
130
+ # `requested_by_customer`.
131
+ #
132
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
133
+ #
134
+ # @return [Increase::Models::RealTimePaymentsRequestForPayment]
135
+ #
136
+ # @see Increase::Models::RealTimePaymentsRequestsForPaymentCancelParams
137
+ def cancel(real_time_payments_request_for_payment_id, params = {})
138
+ parsed, options = Increase::RealTimePaymentsRequestsForPaymentCancelParams.dump_request(params)
139
+ @client.request(
140
+ method: :post,
141
+ path: [
142
+ "real_time_payments_requests_for_payment/%1$s/cancel",
143
+ real_time_payments_request_for_payment_id
144
+ ],
145
+ body: parsed,
146
+ model: Increase::RealTimePaymentsRequestForPayment,
147
+ options: options
148
+ )
149
+ end
150
+
151
+ # @api private
152
+ #
153
+ # @param client [Increase::Client]
154
+ def initialize(client:)
155
+ @client = client
156
+ end
157
+ end
158
+ end
159
+ end
@@ -0,0 +1,43 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Resources
5
+ class Simulations
6
+ class FednowTransfers
7
+ # Simulates submission of a [FedNow Transfer](#fednow-transfers) and handling the
8
+ # response from the destination financial institution. This transfer must first
9
+ # have a `status` of `pending_submitting`.
10
+ #
11
+ # @overload complete(fednow_transfer_id, rejection: nil, request_options: {})
12
+ #
13
+ # @param fednow_transfer_id [String] The identifier of the FedNow Transfer you wish to complete.
14
+ #
15
+ # @param rejection [Increase::Models::Simulations::FednowTransferCompleteParams::Rejection]
16
+ # If set, the simulation will reject the transfer.
17
+ #
18
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
19
+ #
20
+ # @return [Increase::Models::FednowTransfer]
21
+ #
22
+ # @see Increase::Models::Simulations::FednowTransferCompleteParams
23
+ def complete(fednow_transfer_id, params = {})
24
+ parsed, options = Increase::Simulations::FednowTransferCompleteParams.dump_request(params)
25
+ @client.request(
26
+ method: :post,
27
+ path: ["simulations/fednow_transfers/%1$s/complete", fednow_transfer_id],
28
+ body: parsed,
29
+ model: Increase::FednowTransfer,
30
+ options: options
31
+ )
32
+ end
33
+
34
+ # @api private
35
+ #
36
+ # @param client [Increase::Client]
37
+ def initialize(client:)
38
+ @client = client
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end
@@ -42,6 +42,28 @@ module Increase
42
42
  )
43
43
  end
44
44
 
45
+ # Simulates the acceptance of an [Inbound Check Deposit](#inbound-check-deposits),
46
+ # creating a Transaction as a result. The Inbound Check Deposit must first have a
47
+ # `status` of `pending`.
48
+ #
49
+ # @overload accept(inbound_check_deposit_id, request_options: {})
50
+ #
51
+ # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit you wish to accept.
52
+ #
53
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
54
+ #
55
+ # @return [Increase::Models::InboundCheckDeposit]
56
+ #
57
+ # @see Increase::Models::Simulations::InboundCheckDepositAcceptParams
58
+ def accept(inbound_check_deposit_id, params = {})
59
+ @client.request(
60
+ method: :post,
61
+ path: ["simulations/inbound_check_deposits/%1$s/accept", inbound_check_deposit_id],
62
+ model: Increase::InboundCheckDeposit,
63
+ options: params[:request_options]
64
+ )
65
+ end
66
+
45
67
  # Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit
46
68
  # must have a `status` of `accepted`.
47
69
  #
@@ -81,6 +81,9 @@ module Increase
81
81
  # @return [Increase::Resources::Simulations::InboundRealTimePaymentsTransfers]
82
82
  attr_reader :inbound_real_time_payments_transfers
83
83
 
84
+ # @return [Increase::Resources::Simulations::FednowTransfers]
85
+ attr_reader :fednow_transfers
86
+
84
87
  # @return [Increase::Resources::Simulations::InboundFednowTransfers]
85
88
  attr_reader :inbound_fednow_transfers
86
89
 
@@ -145,6 +148,7 @@ module Increase
145
148
  Increase::Resources::Simulations::RealTimePaymentsTransfers.new(client: client)
146
149
  @inbound_real_time_payments_transfers =
147
150
  Increase::Resources::Simulations::InboundRealTimePaymentsTransfers.new(client: client)
151
+ @fednow_transfers = Increase::Resources::Simulations::FednowTransfers.new(client: client)
148
152
  @inbound_fednow_transfers = Increase::Resources::Simulations::InboundFednowTransfers.new(client: client)
149
153
  @check_deposits = Increase::Resources::Simulations::CheckDeposits.new(client: client)
150
154
  @inbound_mail_items = Increase::Resources::Simulations::InboundMailItems.new(client: client)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.353.0"
4
+ VERSION = "1.355.0"
5
5
  end